diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml
index 87d7f66d..8c466452 100644
--- a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml
+++ b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml
@@ -1,4 +1,4 @@
-openapi: 3.1.0
+openapi: 3.0.2
info:
version: v2.0-iso20022-draft
title: Open API for FSP Interoperability (FSPIOP) - the ISO 20022 message version
@@ -1350,29 +1350,33 @@ components:
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: "#/components/schemas/IBAN2007Identifier"
- Othr:
- description: >
- Other
-
- Unique identification of an account, as assigned by the account
- servicer, using an identification scheme.
- $ref: "#/components/schemas/GenericAccountIdentification1"
oneOf:
- - required:
+ - properties:
+ IBAN:
+ allOf:
+ - $ref: "#/components/schemas/IBAN2007Identifier"
+ - 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: "#/components/schemas/GenericAccountIdentification1"
+ - description: >
+ Other
+
+ Unique identification of an account, as assigned by the
+ account servicer, using an identification scheme.
+ required:
- Othr
example:
IBAN: BE71096123456769
@@ -1381,23 +1385,26 @@ components:
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: "#/components/schemas/ExternalAccountIdentification1Code"
- Prtry:
- description: |
- Proprietary
- Name of the identification scheme, in a free text form.
- $ref: "#/components/schemas/Max35Text"
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/ExternalAccountIdentification1Code"
+ - description: >
+ Code
+
+ Name of the identification scheme, in a coded form as
+ published in an external list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Proprietary
+ Name of the identification scheme, in a free text form.
+ required:
- Prtry
example:
Cd: 1111
@@ -1409,12 +1416,14 @@ components:
unit of currency is explicit and compliant with ISO 4217.
properties:
ActiveCurrencyAndAmount:
- $ref: "#/components/schemas/ActiveCurrencyAndAmount_SimpleType"
+ allOf:
+ - $ref: "#/components/schemas/ActiveCurrencyAndAmount_SimpleType"
Ccy:
- description: |
- Currency
- Identification of the currency in which the account is held.
- $ref: "#/components/schemas/ActiveCurrencyCode"
+ allOf:
+ - $ref: "#/components/schemas/ActiveCurrencyCode"
+ - description: |
+ Currency
+ Identification of the currency in which the account is held.
required:
- ActiveCurrencyAndAmount
- Ccy
@@ -1453,12 +1462,19 @@ components:
where the unit of currency is explicit and compliant with ISO 4217.
properties:
ActiveOrHistoricCurrencyAndAmount:
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType"
+ allOf:
+ - $ref: >-
+ #/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType
+ - 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
- Identification of the currency in which the account is held.
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode"
+ allOf:
+ - $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode"
+ - description: |
+ Currency
+ Identification of the currency in which the account is held.
required:
- ActiveOrHistoricCurrencyAndAmount
- Ccy
@@ -1483,8 +1499,13 @@ components:
AddressType2Code:
description: |
AddressType2Code
-
Specifies the type of address.
+ ADDR Address
+ PBOX PostBox
+ HOME Home
+ BIZZ Business
+ MLTO MailingTo
+ DLVY Delivery
enum:
- ADDR
- PBOX
@@ -1499,21 +1520,24 @@ components:
type: object
description: |
Choice of formats for the type of address.
- properties:
- Cd:
- description: |
- Code
- Type of address expressed as a code.
- $ref: "#/components/schemas/AddressType2Code"
- Prtry:
- description: |
- Proprietary
- Type of address expressed as a proprietary code.
- $ref: "#/components/schemas/GenericIdentification30"
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/AddressType2Code"
+ - description: |
+ Code
+ Type of address expressed as a code.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/GenericIdentification30"
+ - description: |
+ Proprietary
+ Type of address expressed as a proprietary code.
+ required:
- Prtry
example:
Cd: ADDR
@@ -1560,23 +1584,26 @@ components:
branch of a financial institution.
properties:
FinInstnId:
- description: >
- FinancialInstitutionIdentification
-
- Unique and unambiguous identification of a financial institution, as
- assigned under an internationally recognised or proprietary
- identification scheme.
- $ref: "#/components/schemas/FinancialInstitutionIdentification18"
+ allOf:
+ - $ref: "#/components/schemas/FinancialInstitutionIdentification18"
+ - description: >
+ FinancialInstitutionIdentification
+
+ Unique and unambiguous identification of a financial
+ institution, as assigned under an internationally recognised or
+ proprietary identification scheme.
BrnchId:
- description: >
- BranchIdentification
+ allOf:
+ - $ref: "#/components/schemas/BranchData3"
+ - 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: "#/components/schemas/BranchData3"
+ 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:
@@ -1604,18 +1631,19 @@ components:
branch of a financial institution.
properties:
FinInstnId:
- description: >
- FinancialInstitutionIdentification
+ allOf:
+ - $ref: "#/components/schemas/FinancialInstitutionIdentification23"
+ - description: >
+ FinancialInstitutionIdentification
- Unique and unambiguous identification of a financial institution or
- a branch of a financial institution.
- $ref: "#/components/schemas/FinancialInstitutionIdentification23"
+ Unique and unambiguous identification of a financial institution
+ or a branch of a financial institution.
BrnchId:
- description: |
- BranchIdentification
-
- Identifies a specific branch of a financial institution.
- $ref: "#/components/schemas/BranchData5"
+ allOf:
+ - $ref: "#/components/schemas/BranchData5"
+ - description: |
+ BranchIdentification
+ Identifies a specific branch of a financial institution.
required:
- FinInstnId
example:
@@ -1643,33 +1671,37 @@ components:
institution.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Identification
- Unique and unambiguous identification of a branch of a financial
- institution.
- $ref: "#/components/schemas/Max35Text"
+ Unique and unambiguous identification of a branch of a financial
+ institution.
LEI:
- description: >
- Legal Entity Identifier
+ allOf:
+ - $ref: "#/components/schemas/LEIIdentifier"
+ - description: >
+ Legal Entity Identifier
- Legal entity identification for the branch of the financial
- institution.
- $ref: "#/components/schemas/LEIIdentifier"
+ Legal entity identification for the branch of the financial
+ institution.
Nm:
- description: >
- Name
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: >
+ Name
- Name by which an agent is known and which is usually used to
- identify that agent.
- $ref: "#/components/schemas/Max140Text"
+ Name by which an agent is known and which is usually used to
+ identify that agent.
PstlAdr:
- description: >
- Postal Address
+ allOf:
+ - $ref: "#/components/schemas/PostalAddress24"
+ - description: >
+ Postal Address
- Information that locates and identifies a specific address, as
- defined by postal services.
- $ref: "#/components/schemas/PostalAddress24"
+ Information that locates and identifies a specific address, as
+ defined by postal services.
example:
Id: 123
Nm: Name
@@ -1692,33 +1724,37 @@ components:
type: object
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Identification
- Unique and unambiguous identification of a branch of a financial
- institution.
- $ref: "#/components/schemas/Max35Text"
+ Unique and unambiguous identification of a branch of a financial
+ institution.
LEI:
- description: >
- LEI
+ allOf:
+ - $ref: "#/components/schemas/LEIIdentifier"
+ - description: >
+ LEI
- Legal entity identification for the branch of the financial
- institution.
- $ref: "#/components/schemas/LEIIdentifier"
+ Legal entity identification for the branch of the financial
+ institution.
Nm:
- description: >
- Name
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: >
+ Name
- Name by which an agent is known and which is usually used to
- identify that agent.
- $ref: "#/components/schemas/Max140Text"
+ Name by which an agent is known and which is usually used to
+ identify that agent.
PstlAdr:
- description: >
- PostalAddress
+ allOf:
+ - $ref: "#/components/schemas/PostalAddress27"
+ - description: >
+ PostalAddress
- Information that locates and identifies a specific address, as
- defined by postal services.
- $ref: "#/components/schemas/PostalAddress27"
+ Information that locates and identifies a specific address, as
+ defined by postal services.
example:
Id: 123
LEI: 123
@@ -1729,11 +1765,6 @@ components:
SubDept: Sub department
StrtNm: Street name
BldgNb: Building number
- PstCd: Post code
- TwnNm: Town name
- CtrySubDvsn: Country subdivision
- Ctry: Country
- AdrLine: Address line
CashAccount40:
title: CashAccount40
type: object
@@ -1741,49 +1772,53 @@ components:
Provides the details to identify an account.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: "#/components/schemas/AccountIdentification4Choice"
+ - description: >
+ Identification
- Unique and unambiguous identification for the account between the
- account owner and the account servicer.
- $ref: "#/components/schemas/AccountIdentification4Choice"
+ Unique and unambiguous identification for the account between
+ the account owner and the account servicer.
Tp:
- description: |
- Type
- Specifies the nature, or use of the account.
- $ref: "#/components/schemas/CashAccountType2Choice"
+ allOf:
+ - $ref: "#/components/schemas/CashAccountType2Choice"
+ - description: |
+ Type
+ Specifies the nature, or use of the account.
Ccy:
- description: >
- Currency
+ allOf:
+ - $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode"
+ - description: >
+ Currency
- Definition: Identification of the currency in which the account is
- held.
+ Identification of the currency in which the account is held.
- Usage: Currency should only be used in case one and the same account
- number covers several currencies and the initiating party needs to
- identify which currency needs to be used for settlement on the
- account.
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode"
+ Usage: Currency should only be used in case one and the same
+ account number covers several currencies and the initiating
+ party needs to identify which currency needs to be used for
+ settlement on the account.
Nm:
- description: >
- Name
-
- Definition: Name of the account, as assigned by the account
- servicing institution, in agreement with the account owner in order
- to provide an additional means of identification of the account.
-
- Usage: The account name is different from the account owner name.
- The account name is used in certain user communities to provide a
- means of identifying the account, in addition to the account owner's
- identity and the account number.
- $ref: "#/components/schemas/Max70Text"
+ allOf:
+ - $ref: "#/components/schemas/Max70Text"
+ - description: >
+ Name
+
+ Name of the account, as assigned by the account servicing
+ institution, in agreement with the account owner in order to
+ provide an additional means of identification of the account.
+
+ Usage: The account name is different from the account owner
+ name. The account name is used in certain user communities to
+ provide a means of identifying the account, in addition to the
+ account owner's identity and the account number.
Prxy:
- description: >
- Proxy
+ allOf:
+ - $ref: "#/components/schemas/ProxyAccountIdentification1"
+ - description: >
+ Proxy
- Specifies an alternate assumed name for the identification of the
- account.
- $ref: "#/components/schemas/ProxyAccountIdentification1"
+ Specifies an alternate assumed name for the identification of
+ the account.
example:
Id:
IBAN: BE71096123456769
@@ -1798,21 +1833,24 @@ components:
description: |
Specifies the nature, or use of the account.
type: object
- properties:
- Cd:
- description: |
- Code
- Account type, in a coded form.
- $ref: "#/components/schemas/ExternalCashAccountType1Code"
- Prtry:
- description: |
- Proprietary
- Nature or use of the account in a proprietary form.
- $ref: "#/components/schemas/Max35Text"
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/ExternalCashAccountType1Code"
+ - description: |
+ Code
+ Account type, in a coded form.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Proprietary
+ Nature or use of the account in a proprietary form.
+ required:
- Prtry
example:
Cd: CACC
@@ -1822,23 +1860,26 @@ components:
Contains details about high level purpose of the mandate based on a set
of pre-defined categories.
type: object
- properties:
- Cd:
- description: >
- Code
-
- Category purpose, as published in an external category purpose code
- list.
- $ref: "#/components/schemas/ExternalCategoryPurpose1Code"
- Prtry:
- description: |
- Proprietary
- Category purpose, in a proprietary form.
- $ref: "#/components/schemas/Max35Text"
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/ExternalCategoryPurpose1Code"
+ - description: >
+ Code
+
+ Category purpose, as published in an external category
+ purpose code list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Proprietary
+ Category purpose, in a proprietary form.
+ required:
- Prtry
example:
Cd: CASH
@@ -1846,22 +1887,24 @@ components:
title: ChargeBearerType1Code
description: >
Specifies which party(ies) will pay charges due for processing of the
+
instruction.
- DEBT BorneByDebtor All transaction charges are to be borne by the
+
+ DEBT: BorneByDebtor All transaction charges are to be borne by the
debtor.
- CRED BorneByCreditor All transaction charges are to be borne by the
+ CRED: BorneByCreditor All transaction charges are to be borne by the
creditor.
- SHAR Shared In a credit transfer context, means that transaction charges
- on the sender side are to be borne by the debtor, transaction charges on
- the receiver side are to be borne by the creditor. In a direct debit
- context, means that transaction charges on the sender side are to be
- borne by the creditor, transaction charges on the receiver
-
- SLEV FollowingServiceLevel Charges are to be applied following the rules
- agreed in the service level.
+ SHAR: Shared In a credit transfer context, means that transaction
+ charges on
+ the sender side are to be borne by the debtor, transaction charges on the receiver side are to
+ be borne by the creditor. In a direct debit context, means that transaction charges on the sender side
+ are to be borne by the creditor, transaction charges on the receiver
+ SLEV : FollowingServiceLevel Charges are to be applied following the
+ rules
+ agreed in the service level.
type: string
enum:
- DEBT
@@ -1875,21 +1918,26 @@ components:
ChargeType3Choice
Specifies the type of charge.
type: object
- properties:
- Cd:
- description: |
- Code
- Charge type, in a coded form.
- $ref: "#/components/schemas/ExternalChargeType1Code"
- Prtry:
- description: |
- Proprietary
- Type of charge in a proprietary form, as defined by the issuer.
- $ref: "#/components/schemas/GenericIdentification3"
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/ExternalChargeType1Code"
+ - description: |
+ Code
+ Charge type, in a coded form.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/GenericIdentification3"
+ - description: >
+ Proprietary
+
+ Type of charge in a proprietary form, as defined by the
+ issuer.
+ required:
- Prtry
example:
Cd: CASH
@@ -1902,24 +1950,26 @@ components:
type: object
properties:
Amt:
- description: |
- Amount
-
- Transaction charges to be paid by the charge bearer.
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ allOf:
+ - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ - description: |
+ Amount
+ Transaction charges to be paid by the charge bearer.
Agt:
- description: >
- Agent
-
- Agent that takes the transaction charges or to which the transaction
- charges are due.
- $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
+ allOf:
+ - $ref: >-
+ #/components/schemas/BranchAndFinancialInstitutionIdentification8
+ - description: >
+ Agent
+
+ Agent that takes the transaction charges or to which the
+ transaction charges are due.
Tp:
- description: |
- Type
-
- Defines the type of charges.
- $ref: "#/components/schemas/ChargeType3Choice"
+ allOf:
+ - $ref: "#/components/schemas/ChargeType3Choice"
+ - description: |
+ Type
+ Defines the type of charges.
required:
- Amt
- Agt
@@ -1938,18 +1988,21 @@ components:
title: ClearingChannel2Code
description: >
Specifies the clearing channel for the routing of the transaction, as
- part of the payment type identification.
+ part of
- RTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross
- settlement system.
+ the payment type identification.
+
+
+ RTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time
+ gross settlement system.
- RTNS RealTimeNetSettlementSystem Clearing channel is a real-time net
+ RTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net
settlement system.
- MPNS MassPaymentNetSystem Clearing channel is a mass payment net
+ MPNS: MassPaymentNetSystem Clearing channel is a mass payment net
settlement system.
- BOOK BookTransfer Payment through internal book transfer.
+ BOOK: BookTransfer Payment through internal book transfer.
type: string
enum:
- RTGS
@@ -1960,28 +2013,32 @@ components:
ClearingSystemIdentification2Choice:
title: ClearingSystemIdentification2Choice
description: |
- Choice of a clearing system identifier.
+ Specifies the clearing system identification.
type: object
- properties:
- Cd:
- description: |
- Code
- Identification of a member of a clearing system
- $ref: "#/components/schemas/ExternalClearingSystemIdentification1Code"
- Prtry:
- description: >
- Proprietary
-
- Identification code for a clearing system, that has not yet been
- identified in the list of clearing systems.
- $ref: "#/components/schemas/Max35Text"
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: >-
+ #/components/schemas/ExternalClearingSystemIdentification1Code
+ - description: >
+ Code
+
+ Clearing system identification code, as published in an
+ external list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Proprietary
+ Proprietary identification of the clearing system.
+ required:
- Prtry
example:
- Cd: CHQB
+ Cd: CHIPS
ClearingSystemMemberIdentification2:
title: ClearingSystemMemberIdentification2
description: >
@@ -1990,17 +2047,20 @@ components:
type: object
properties:
ClrSysId:
- description: >
- ClearingSystemIdentification.
-
- Specification of a pre-agreed offering between clearing agents or
- the channel through which the payment instruction is processed.
- $ref: "#/components/schemas/ClearingSystemIdentification2Choice"
+ allOf:
+ - $ref: "#/components/schemas/ClearingSystemIdentification2Choice"
+ - description: >
+ ClearingSystemIdentification
+
+ Specification of a pre-agreed offering between clearing agents
+ or the channel through which the payment instruction is
+ processed.
MmbId:
- description: |
- MemberIdentification.
- Identification of a member of a clearing system.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ MemberIdentification
+ Identification of a member of a clearing system.
required:
- MmbId
example:
@@ -2014,80 +2074,95 @@ components:
type: object
properties:
NmPrfx:
- description: |
- NamePrefix
- Specifies the terms used to formally address a person.
- $ref: "#/components/schemas/NamePrefix2Code"
+ allOf:
+ - $ref: "#/components/schemas/NamePrefix2Code"
+ - description: |
+ NamePrefix
+ Specifies the terms used to formally address a person.
Nm:
- description: >
- Name
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: >
+ Name
- Name by which a party is known and which is usually used to identify
- that party.
- $ref: "#/components/schemas/Max140Text"
+ Name by which a party is known and which is usually used to
+ identify that party.
PhneNb:
- description: >
- PhoneNumber
+ allOf:
+ - $ref: "#/components/schemas/PhoneNumber"
+ - description: >
+ PhoneNumber
- Collection of information that identifies a phone number, as defined
- by telecom services.
- $ref: "#/components/schemas/PhoneNumber"
+ Collection of information that identifies a phone number, as
+ defined by telecom services.
MobNb:
- description: >
- MobilePhoneNumber
+ allOf:
+ - $ref: "#/components/schemas/PhoneNumber"
+ - description: >
+ MobilePhoneNumber
- Collection of information that identifies a mobile phone number, as
- defined by telecom services.
- $ref: "#/components/schemas/PhoneNumber"
+ Collection of information that identifies a mobile phone number,
+ as defined by telecom services.
FaxNb:
- description: >
- FaxNumber
+ allOf:
+ - $ref: "#/components/schemas/PhoneNumber"
+ - description: >
+ FaxNumber
- Collection of information that identifies a fax number, as defined
- by telecom services.
- $ref: "#/components/schemas/PhoneNumber"
+ Collection of information that identifies a fax number, as
+ defined by telecom services.
URLAdr:
- description: >
- URLAddress
+ allOf:
+ - $ref: "#/components/schemas/Max2048Text"
+ - description: >
+ URLAddress
- Address for the Universal Resource Locator (URL), for example an
- address used over the www (HTTP) service.
- $ref: "#/components/schemas/Max2048Text"
+ Address for the Universal Resource Locator (URL), for example an
+ address used over the www (HTTP) service.
EmailAdr:
- description: |
- EmailAddress
- Address for electronic mail (e-mail).
- $ref: "#/components/schemas/Max256Text"
+ allOf:
+ - $ref: "#/components/schemas/Max256Text"
+ - description: |
+ EmailAddress
+ Address for electronic mail (e-mail).
EmailPurp:
- description: |
- EmailPurpose
- Purpose for which an email address may be used.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ EmailPurpose
+ Purpose for which an email address may be used.
JobTitl:
- description: |
- JobTitle
- Title of the function.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ JobTitle
+ Title of the function.
Rspnsblty:
- description: |
- Responsibility
- Role of a person in an organisation.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Responsibility
+ Role of a person in an organisation.
Dept:
- description: |
- Department
- Identification of a division of a large organisation or building.
- $ref: "#/components/schemas/Max70Text"
+ allOf:
+ - $ref: "#/components/schemas/Max70Text"
+ - description: >
+ Department
+
+ Identification of a division of a large organisation or
+ building.
Othr:
- description: |
- OtherContact
- Contact details in another form.
- $ref: "#/components/schemas/OtherContact1"
+ allOf:
+ - $ref: "#/components/schemas/OtherContact1"
+ - description: |
+ OtherContact
+ Contact details in another form.
PrefrdMtd:
- description: |
- PreferredContactMethod
- Preferred method used to reach the contact.
- $ref: "#/components/schemas/PreferredContactMethod2Code"
+ allOf:
+ - $ref: "#/components/schemas/PreferredContactMethod2Code"
+ - description: |
+ PreferredContactMethod
+ Preferred method used to reach the contact.
example:
NmPrfx: Mr
Nm: John Doe
@@ -2103,73 +2178,87 @@ components:
type: object
properties:
NmPrfx:
- description: |
- NamePrefix
- Name prefix to be used before the name of the person.
- $ref: "#/components/schemas/NamePrefix2Code"
+ allOf:
+ - $ref: "#/components/schemas/NamePrefix2Code"
+ - description: |
+ NamePrefix
+ Name prefix to be used before the name of the person.
Nm:
- description: >
- Name
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: >
+ Name
- Name by which a party is known and which is usually used to identify
- that party.
- $ref: "#/components/schemas/Max140Text"
+ Name by which a party is known and which is usually used to
+ identify that party.
PhneNb:
- description: >
- PhoneNumber
+ allOf:
+ - $ref: "#/components/schemas/PhoneNumber"
+ - description: >
+ PhoneNumber
- Collection of information that identifies a phone number, as defined
- by telecom services.
- $ref: "#/components/schemas/PhoneNumber"
+ Collection of information that identifies a phone number, as
+ defined by telecom services.
MobNb:
- description: >
- MobilePhoneNumber
+ allOf:
+ - $ref: "#/components/schemas/PhoneNumber"
+ - description: >
+ MobilePhoneNumber
- Collection of information that identifies a mobile phone number, as
- defined by telecom services.
- $ref: "#/components/schemas/PhoneNumber"
+ Collection of information that identifies a mobile phone number,
+ as defined by telecom services.
FaxNb:
- description: >
- FaxNumber
+ allOf:
+ - $ref: "#/components/schemas/PhoneNumber"
+ - description: >
+ FaxNumber
- Collection of information that identifies a fax number, as defined
- by telecom services.
- $ref: "#/components/schemas/PhoneNumber"
+ Collection of information that identifies a fax number, as
+ defined by telecom services.
EmailAdr:
- description: |
- EmailAddress
- Address for electronic mail (e-mail).
- $ref: "#/components/schemas/Max2048Text"
+ allOf:
+ - $ref: "#/components/schemas/Max2048Text"
+ - description: |
+ EmailAddress
+ Address for electronic mail (e-mail).
EmailPurp:
- description: |
- EmailPurpose
- Purpose for which an email address may be used.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ EmailPurpose
+ Purpose for which an email address may be used.
JobTitl:
- description: |
- JobTitle
- Title of the function.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ JobTitle
+ Title of the function.
Rspnsblty:
- description: |
- Responsibility
- Role of a person in an organisation.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Responsibility
+ Role of a person in an organisation.
Dept:
- description: |
- Department
- Identification of a division of a large organisation or building.
- $ref: "#/components/schemas/Max70Text"
+ allOf:
+ - $ref: "#/components/schemas/Max70Text"
+ - description: >
+ Department
+
+ Identification of a division of a large organisation or
+ building.
Othr:
- description: |
- Other
- : Contact details in another form.
- $ref: "#/components/schemas/OtherContact1"
+ allOf:
+ - $ref: "#/components/schemas/OtherContact1"
+ - description: |
+ Other
+ Contact details in another form.
PrefrdMtd:
- description: |
- PreferredMethod
- Preferred method used to reach the contact.
- $ref: "#/components/schemas/PreferredContactMethod1Code"
+ allOf:
+ - $ref: "#/components/schemas/PreferredContactMethod1Code"
+ - description: |
+ PreferredMethod
+ Preferred method used to reach the contact.
example:
NmPrfx: Mr
Nm: John Doe
@@ -2194,116 +2283,130 @@ components:
type: object
properties:
PmtId:
- description: |
- PaymentIdentification
- Set of elements used to reference a payment instruction.
- $ref: "#/components/schemas/PaymentIdentification13"
+ allOf:
+ - $ref: "#/components/schemas/PaymentIdentification13"
+ - description: |
+ PaymentIdentification
+ Set of elements used to reference a payment instruction.
PmtTpInf:
- description: |
- PaymentTypeInformation
-
- Set of elements used to further specify the type of transaction.
- $ref: "#/components/schemas/PaymentTypeInformation28"
+ allOf:
+ - $ref: "#/components/schemas/PaymentTypeInformation28"
+ - description: |
+ PaymentTypeInformation
+ Set of elements used to further specify the type of transaction.
IntrBkSttlmAmt:
- description: >
- InterbankSettlementAmount
+ allOf:
+ - $ref: "#/components/schemas/ActiveCurrencyAndAmount"
+ - description: >
+ InterbankSettlementAmount
- Amount of money moved between the instructing agent and the
- instructed agent.
- $ref: "#/components/schemas/ActiveCurrencyAndAmount"
+ Amount of money moved between the instructing agent and the
+ instructed agent.
InstdAmt:
- description: >
- InstructedAmount
-
- 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.
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ allOf:
+ - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ - description: >
+ InstructedAmount
+
+ 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.
XchgRate:
- description: >
- ExchangeRate
-
- Factor used to convert an amount from one currency into another.
- This reflects the price at which one currency was bought with
- another currency.
- $ref: "#/components/schemas/BaseOneRate"
+ allOf:
+ - $ref: "#/components/schemas/BaseOneRate"
+ - description: >
+ ExchangeRate
+
+ Factor used to convert an amount from one currency into another.
+ This reflects the price at which one currency was bought with
+ another currency.
ChrgBr:
- description: >
- ChargeBearer
-
- Specifies which party/parties will bear the charges associated with
- the processing of the payment transaction.
$ref: "#/components/schemas/ChargeBearerType1Code"
ChrgsInf:
- description: >
- ChargesInformation
+ allOf:
+ - $ref: "#/components/schemas/Charges16"
+ - description: >
+ ChargesInformation
- Provides information on the charges to be paid by the charge
- bearer(s) related to the payment transaction
- $ref: "#/components/schemas/Charges16"
+ Provides information on the charges to be paid by the charge
+ bearer(s) related to the payment transaction.
Dbtr:
- description: |
- Debtor
- Party that owes an amount of money to the (ultimate) creditor.
- $ref: "#/components/schemas/PartyIdentification272"
+ allOf:
+ - $ref: "#/components/schemas/PartyIdentification272"
+ - description: |
+ Debtor
+ Party that owes an amount of money to the (ultimate) creditor.
DbtrAcct:
- description: >
- DebtorAccount
+ allOf:
+ - $ref: "#/components/schemas/CashAccount40"
+ - description: >
+ DebtorAccount
- Unambiguous identification of the account of the debtor to which a
- debit entry will be made as a result of the transaction.
- $ref: "#/components/schemas/CashAccount40"
+ Unambiguous identification of the account of the debtor to which
+ a debit entry will be made as a result of the transaction.
DbtrAgt:
- description: |
- DebtorAgent
- Financial institution servicing an account for the debtor.
- $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
+ allOf:
+ - $ref: >-
+ #/components/schemas/BranchAndFinancialInstitutionIdentification8
+ - description: |
+ DebtorAgent
+ Financial institution servicing an account for the debtor.
CdtrAgt:
- description: |
- CreditorAgent
- Financial institution servicing an account for the creditor.
- $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
+ allOf:
+ - $ref: >-
+ #/components/schemas/BranchAndFinancialInstitutionIdentification8
+ - description: |
+ CreditorAgent
+ Financial institution servicing an account for the creditor.
Cdtr:
- description: |
- Creditor
- Party to which an amount of money is due.
- $ref: "#/components/schemas/PartyIdentification272"
+ allOf:
+ - $ref: "#/components/schemas/PartyIdentification272"
+ - description: |
+ Creditor
+ Party to which an amount of money is due.
CdtrAcct:
- description: >
- CreditorAccount
-
- Unambiguous identification of the account of the creditor to which a
- credit entry will be posted as a result of the payment transaction.
- $ref: "#/components/schemas/CashAccount40"
+ allOf:
+ - $ref: "#/components/schemas/CashAccount40"
+ - description: >
+ CreditorAccount
+
+ Unambiguous identification of the account of the creditor to
+ which a credit entry will be posted as a result of the payment
+ transaction.
InstrForCdtrAgt:
- description: >
- InstructionForCreditorAgent
+ allOf:
+ - $ref: "#/components/schemas/InstructionForCreditorAgent3"
+ - description: >
+ InstructionForCreditorAgent
- Set of elements used to provide information on the remittance
- advice.
- $ref: "#/components/schemas/InstructionForCreditorAgent3"
+ Set of elements used to provide information on the remittance
+ advice.
InstrForNxtAgt:
- description: >
- InstructionForNextAgent
+ allOf:
+ - $ref: "#/components/schemas/InstructionForNextAgent1"
+ - description: >
+ InstructionForNextAgent
- Set of elements used to provide information on the remittance
- advice.
- $ref: "#/components/schemas/InstructionForNextAgent1"
+ Set of elements used to provide information on the remittance
+ advice.
Purp:
- description: |
- Purpose
- Underlying reason for the payment transaction.
- $ref: "#/components/schemas/Purpose2Choice"
+ allOf:
+ - $ref: "#/components/schemas/Purpose2Choice"
+ - description: |
+ Purpose
+ Underlying reason for the payment transaction.
RgltryRptg:
- description: |
- RegulatoryReporting
- Information needed due to regulatory and statutory requirements.
- $ref: "#/components/schemas/RegulatoryReporting3"
+ allOf:
+ - $ref: "#/components/schemas/RegulatoryReporting3"
+ - description: |
+ RegulatoryReporting
+ Information needed due to regulatory and statutory requirements.
Tax:
- description: |
- Tax
- Provides details on the tax.
- $ref: "#/components/schemas/TaxData1"
+ allOf:
+ - $ref: "#/components/schemas/TaxData1"
+ - description: |
+ Tax
+ Provides details on the tax.
VrfctnOfTerms:
$ref: "#/components/schemas/CryptographicLockChoice"
required:
@@ -2394,72 +2497,87 @@ components:
type: object
properties:
PmtId:
- description: |
- PaymentIdentification
- Set of elements used to reference a payment instruction.
- $ref: "#/components/schemas/PaymentIdentification13"
+ allOf:
+ - $ref: "#/components/schemas/PaymentIdentification13"
+ - description: |
+ PaymentIdentification
+ Set of elements used to reference a payment instruction.
PmtTpInf:
- description: |
- PaymentTypeInformation
-
- Set of elements used to further specify the type of transaction.
- $ref: "#/components/schemas/PaymentTypeInformation28"
+ allOf:
+ - $ref: "#/components/schemas/PaymentTypeInformation28"
+ - description: |
+ PaymentTypeInformation
+ Set of elements used to further specify the type of transaction.
IntrBkSttlmAmt:
- description: >
- InterbankSettlementAmount
+ allOf:
+ - $ref: "#/components/schemas/ActiveCurrencyAndAmount"
+ - description: >
+ InterbankSettlementAmount
- Amount of money moved between the instructing agent and the
- instructed agent.
- $ref: "#/components/schemas/ActiveCurrencyAndAmount"
+ Amount of money moved between the instructing agent and the
+ instructed agent.
Dbtr:
- description: |
- Debtor
- Party that owes an amount of money to the (ultimate) creditor.
- $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
+ allOf:
+ - $ref: >-
+ #/components/schemas/BranchAndFinancialInstitutionIdentification8
+ - description: |
+ Debtor
+ Party that owes an amount of money to the (ultimate) creditor.
DbtrAcct:
- description: |
- DebtorAccount
- Account used to process a payment.
- $ref: "#/components/schemas/CashAccount40"
+ allOf:
+ - $ref: "#/components/schemas/CashAccount40"
+ - description: |
+ DebtorAccount
+ Account used to process a payment.
DbtrAgt:
- description: |
- DebtorAgent
- Financial institution servicing an account for the debtor.
- $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
+ allOf:
+ - $ref: >-
+ #/components/schemas/BranchAndFinancialInstitutionIdentification8
+ - description: |
+ DebtorAgent
+ Financial institution servicing an account for the debtor.
CdtrAgt:
- description: |
- CreditorAgent
- Financial institution servicing an account for the creditor.
- $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
+ allOf:
+ - $ref: >-
+ #/components/schemas/BranchAndFinancialInstitutionIdentification8
+ - description: |
+ CreditorAgent
+ Financial institution servicing an account for the creditor.
Cdtr:
- description: |
- Creditor
- Party to which an amount of money is due.
- $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
+ allOf:
+ - $ref: >-
+ #/components/schemas/BranchAndFinancialInstitutionIdentification8
+ - description: |
+ Creditor
+ Party to which an amount of money is due.
CdtrAcct:
- description: |
- CreditorAccount
- Account to which a credit entry is made.
- $ref: "#/components/schemas/CashAccount40"
+ allOf:
+ - $ref: "#/components/schemas/CashAccount40"
+ - description: |
+ CreditorAccount
+ Account to which a credit entry is made.
InstrForCdtrAgt:
- description: >
- InstructionForCreditorAgent
+ allOf:
+ - $ref: "#/components/schemas/InstructionForCreditorAgent3"
+ - description: >
+ InstructionForCreditorAgent
- Set of elements used to provide information on the remittance
- advice.
- $ref: "#/components/schemas/InstructionForCreditorAgent3"
+ Set of elements used to provide information on the remittance
+ advice.
Purp:
- description: |
- Purpose
- Underlying reason for the payment transaction.
- $ref: "#/components/schemas/Purpose2Choice"
+ allOf:
+ - $ref: "#/components/schemas/Purpose2Choice"
+ - description: |
+ Purpose
+ Underlying reason for the payment transaction.
VrfctnOfTerms:
- description: >
- VerificationOfTerms
+ allOf:
+ - $ref: "#/components/schemas/CryptographicLockChoice"
+ - description: >
+ VerificationOfTerms
- Set of elements used to provide information on the underlying terms
- of the transaction.
- $ref: "#/components/schemas/CryptographicLockChoice"
+ Set of elements used to provide information on the underlying
+ terms of the transaction.
required:
- PmtId
- IntrBkSttlmAmt
@@ -2502,17 +2620,25 @@ components:
CryptographicLockChoice:
title: CryptographicLockChoice
description: |
- NOTE: Unsure on description.
+ Cryptographically signed terms
type: object
- properties:
- IlpV4PrepPacket:
- $ref: "#/components/schemas/hexBinary"
- Sh256Sgntr:
- $ref: "#/components/schemas/Exact32HexBinaryText"
oneOf:
- - required:
+ - properties:
+ IlpV4PrepPacket:
+ allOf:
+ - $ref: "#/components/schemas/hexBinary"
+ - description: >
+ Interledger Protocol packet (ILPv4) containing
+ Cryptographically signed terms
+ required:
- IlpV4PrepPacket
- - required:
+ - properties:
+ Sh256Sgntr:
+ allOf:
+ - $ref: "#/components/schemas/Exact32HexBinaryText"
+ - description: |
+ SHA-256 signature of the terms
+ required:
- Sh256Sgntr
example:
IlpV4PrepPacket: 1234567890ABCDEF
@@ -2523,25 +2649,29 @@ components:
type: object
properties:
BirthDt:
- description: |
- BirthDate
- Date on which a person is born.
- $ref: "#/components/schemas/ISODate"
+ allOf:
+ - $ref: "#/components/schemas/ISODate"
+ - description: |
+ BirthDate
+ Date on which a person was born.
PrvcOfBirth:
- description: |
- ProvinceOfBirth
- Province where a person was born.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ ProvinceOfBirth
+ Province where a person was born.
CityOfBirth:
- description: |
- CityOfBirth
- City where a person was born.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ CityOfBirth
+ City where a person was born.
CtryOfBirth:
- description: |
- CountryOfBirth
- Country where a person was born.
- $ref: "#/components/schemas/CountryCode"
+ allOf:
+ - $ref: "#/components/schemas/CountryCode"
+ - description: |
+ CountryOfBirth
+ Country where a person was born.
required:
- BirthDt
- CityOfBirth
@@ -2558,21 +2688,23 @@ components:
type: object
properties:
FrDt:
- description: |
- FromDate
- Start date of the range.
- $ref: "#/components/schemas/ISODate"
+ allOf:
+ - $ref: "#/components/schemas/ISODate"
+ - description: |
+ FromDate
+ Start date of the range.
ToDt:
- description: |
- ToDate
- End date of the range.
- $ref: "#/components/schemas/ISODate"
+ allOf:
+ - $ref: "#/components/schemas/ISODate"
+ - description: |
+ ToDate
+ End date of the range.
required:
- FrDt
- ToDt
example:
- FrDt: "2022-01-01T00:00:00.000Z"
- ToDt: "2022-12-31T23:59:59.999Z"
+ FrDt: "2022-01-01"
+ ToDt: "2022-12-31"
ErrorCode:
title: ErrorCode
type: string
@@ -2634,13 +2766,21 @@ components:
type: object
properties:
GrpHdr:
- description: |
- GroupHeader.
- $ref: "#/components/schemas/GroupHeader129"
+ allOf:
+ - $ref: "#/components/schemas/GroupHeader129"
+ - description: >
+ Group Header
+
+ Set of characteristics shared by all individual transactions
+ included in the message.
CdtTrfTxInf:
- description: |
- CreditTransferTransactionInformation.
- $ref: "#/components/schemas/CreditTransferTransaction67"
+ allOf:
+ - $ref: "#/components/schemas/CreditTransferTransaction67"
+ - description: >
+ Credit Transfer Transaction Information
+
+ Set of elements providing information specific to the individual
+ credit transfer(s).
required:
- GrpHdr
- CdtTrfTxInf
@@ -2659,26 +2799,6 @@ components:
Nm: John Doe
SttlmAcctSvcr:
BICFI: 123
- CdtTrfTxInf:
- PmtId:
- InstrId: 123
- EndToEndId: 123
- PmtTpInf:
- InstrPrty: NORM
- InstdAmt:
- Amt: 123
- Ccy: EUR
- ChrgBr: SLEV
- CdtrAgt:
- FinInstnId:
- BICFI: 123
- Cdtr:
- Nm: John Doe
- CdtrAcct:
- Id:
- IBAN: 123
- RmtInf:
- Ustrd: Test
CdtTrfTxInf:
PmtId:
InstrId: 123
@@ -2769,78 +2889,93 @@ components:
example: 1234
ExternalChargeType1Code:
title: ExternalChargeType1Code
+ description: |
+ Specifies the type of charge applied to the transaction.
type: string
minLength: 1
maxLength: 4
example: 1234
ExternalClearingSystemIdentification1Code:
title: ExternalClearingSystemIdentification1Code
+ description: |
+ Specifies the external clearing system identification code.
type: string
minLength: 1
maxLength: 5
example: 12345
ExternalCreditorAgentInstruction1Code:
title: ExternalCreditorAgentInstruction1Code
+ description: Specifies the instruction given by the creditor to the creditor agent.
type: string
minLength: 1
maxLength: 4
example: 1234
ExternalFinancialInstitutionIdentification1Code:
title: ExternalFinancialInstitutionIdentification1Code
+ description: Specifies the external financial institution identification code.
type: string
minLength: 1
maxLength: 4
example: 1234
ExternalLocalInstrument1Code:
title: ExternalLocalInstrument1Code
+ description: Specifies the external local instrument identification code.
type: string
minLength: 1
maxLength: 35
example: 12345
ExternalOrganisationIdentification1Code:
title: ExternalOrganisationIdentification1Code
+ description: Specifies the external organisation identification code.
type: string
minLength: 1
maxLength: 4
example: 1234
ExternalPaymentTransactionStatus1Code:
title: ExternalPaymentTransactionStatus1Code
+ description: Specifies the external payment transaction status code.
type: string
minLength: 1
maxLength: 4
example: 1234
ExternalPersonIdentification1Code:
title: ExternalPersonIdentification1Code
+ description: Specifies the external person identification code.
type: string
minLength: 1
maxLength: 4
example: 1234
ExternalProxyAccountType1Code:
title: ExternalProxyAccountType1Code
+ description: Specifies the external proxy account type code.
type: string
minLength: 1
maxLength: 4
example: 1234
ExternalPurpose1Code:
title: ExternalPurpose1Code
+ description: Specifies the external purpose code.
type: string
minLength: 1
maxLength: 4
example: 1234
ExternalServiceLevel1Code:
title: ExternalServiceLevel1Code
+ description: Specifies the external service level code.
type: string
minLength: 1
maxLength: 4
example: 1234
ExternalStatusReason1Code:
title: ExternalStatusReason1Code
+ description: Specifies the external status reason code.
type: string
minLength: 1
maxLength: 4
example: 1234
ExternalVerificationReason1Code:
title: ExternalVerificationReason1Code
+ description: Specifies the external verification reason code.
type: string
minLength: 1
maxLength: 4
@@ -2848,69 +2983,85 @@ components:
FinancialIdentificationSchemeName1Choice:
title: FinancialIdentificationSchemeName1Choice
type: object
- properties:
- Cd:
- description: >
- Code
-
- Name of the identification scheme, in a coded form as published in
- an external list.
- $ref: "#/components/schemas/ExternalFinancialInstitutionIdentification1Code"
- Prtry:
- description: |
- Proprietary
- Name of the identification scheme, in a free text form.
- $ref: "#/components/schemas/Max35Text"
+ description: |
+ Specifies the name of the identification scheme.
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: >-
+ #/components/schemas/ExternalFinancialInstitutionIdentification1Code
+ - description: >
+ Code
+
+ Name of the identification scheme, in a coded form as
+ published in an external list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Proprietary
+ Name of the identification scheme, in a free text form.
+ required:
- Prtry
example:
Cd: BIC
FinancialInstitutionIdentification18:
title: FinancialInstitutionIdentification18
type: object
+ description: |
+ Information used to identify a financial institution.
properties:
BICFI:
- description: >
- BICFI
-
- Code allocated to a financial institution by the ISO 9362
- Registration Authority as described in ISO 9362 "Banking - Banking
- telecommunication messages - Business identifier code (BIC)"
- $ref: "#/components/schemas/BICFIDec2014Identifier"
+ allOf:
+ - $ref: "#/components/schemas/BICFIDec2014Identifier"
+ - description: >
+ BICFI
+
+ Code allocated to a financial institution by the ISO 9362
+ Registration Authority as described in ISO 9362 "Banking -
+ Banking telecommunication messages - Business identifier code
+ (BIC)"
ClrSysMmbId:
- description: |
- ClearingSystemMemberIdentification
- Information used to identify a member within a clearing system
- $ref: "#/components/schemas/ClearingSystemMemberIdentification2"
+ allOf:
+ - $ref: "#/components/schemas/ClearingSystemMemberIdentification2"
+ - description: |
+ ClearingSystemMemberIdentification
+ Information used to identify a member within a clearing system
LEI:
- description: |
- LEI
- Legal entity identifier of the financial institution.
- $ref: "#/components/schemas/LEIIdentifier"
+ allOf:
+ - $ref: "#/components/schemas/LEIIdentifier"
+ - description: |
+ LEI
+ Legal entity identifier of the financial institution.
Nm:
- description: >
- Name
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: >
+ Name
- Name by which an agent is known and which is usually used to
- identify that agent
- $ref: "#/components/schemas/Max140Text"
+ Name by which an agent is known and which is usually used to
+ identify that agent
PstlAdr:
- description: >
- PostalAddress
+ allOf:
+ - $ref: "#/components/schemas/PostalAddress24"
+ - description: >
+ PostalAddress
- Information that locates and identifies a specific address, as
- defined by postal services.
- $ref: "#/components/schemas/PostalAddress24"
+ Information that locates and identifies a specific address, as
+ defined by postal services.
Othr:
- description: >
- Other
-
- Unique identification of an agent, as assigned by an institution,
- using an identification scheme.
- $ref: "#/components/schemas/GenericFinancialIdentification1"
+ allOf:
+ - $ref: "#/components/schemas/GenericFinancialIdentification1"
+ - description: >
+ Other
+
+ Unique identification of an agent, as assigned by an
+ institution, using an identification scheme.
+ required: []
example:
BICFI: J5BMVH7D
ClrSysMmbId:
@@ -2938,52 +3089,61 @@ components:
FinancialInstitutionIdentification23:
title: FinancialInstitutionIdentification23
type: object
+ description: |
+ Information used to identify a financial institution.
properties:
BICFI:
- description: >
- BICFI
-
- Code allocated to a financial institution by the ISO 9362
- Registration Authority as described in ISO 9362 "Banking - Banking
- telecommunication messages - Business identifier code (BIC)"
- $ref: "#/components/schemas/BICFIDec2014Identifier"
+ allOf:
+ - $ref: "#/components/schemas/BICFIDec2014Identifier"
+ - description: >
+ BICFI
+
+ Code allocated to a financial institution by the ISO 9362
+ Registration Authority as described in ISO 9362 "Banking -
+ Banking telecommunication messages - Business identifier code
+ (BIC)"
ClrSysMmbId:
- description: |
- ClearingSystemMemberIdentification
- Information used to identify a member within a clearing system
- $ref: "#/components/schemas/ClearingSystemMemberIdentification2"
+ allOf:
+ - $ref: "#/components/schemas/ClearingSystemMemberIdentification2"
+ - description: |
+ ClearingSystemMemberIdentification
+ Information used to identify a member within a clearing system
LEI:
- description: |
- LEI
- Legal entity identifier of the financial institution.
- $ref: "#/components/schemas/LEIIdentifier"
+ allOf:
+ - $ref: "#/components/schemas/LEIIdentifier"
+ - description: |
+ LEI
+ Legal entity identifier of the financial institution.
Nm:
- description: >
- Name
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: >
+ Name
- Name by which an agent is known and which is usually used to
- identify that agent
- $ref: "#/components/schemas/Max140Text"
+ Name by which an agent is known and which is usually used to
+ identify that agent
PstlAdr:
- description: >
- PostalAddress
+ allOf:
+ - $ref: "#/components/schemas/PostalAddress24"
+ - description: >
+ PostalAddress
- Information that locates and identifies a specific address, as
- defined by postal services.
- $ref: "#/components/schemas/PostalAddress27"
+ Information that locates and identifies a specific address, as
+ defined by postal services.
Othr:
- description: >
- Other
-
- Unique identification of an agent, as assigned by an institution,
- using an identification scheme.
- $ref: "#/components/schemas/GenericFinancialIdentification1"
+ allOf:
+ - $ref: "#/components/schemas/GenericFinancialIdentification1"
+ - description: >
+ Other
+
+ Unique identification of an agent, as assigned by an
+ institution, using an identification scheme.
+ required: []
example:
BICFI: J5BMVH7D
ClrSysMmbId:
- ClrSysId:
- Cd: CHQB
- MmbId: 123456789
+ ClrSysId: 1234
+ MmbId: 123
LEI: 123
Nm: Name
PstlAdr:
@@ -3000,19 +3160,26 @@ components:
Othr:
Id: 123
SchmeNm:
- Cd: CHQB
+ Cd: 123
+ Prtry: 123
Issr: 123
FxRequest_FICreditTransferProposal:
title: FxRequest_FICreditTransferProposal
type: object
+ description: >
+ FxRequest_FICreditTransferProposal
+
+ A group of elements providing information specific to the individual
+ credit transfer(s) included in the message.
properties:
GrpHdr:
- description: >
- GroupHeader
+ allOf:
+ - $ref: "#/components/schemas/GroupHeader113"
+ - description: >
+ GroupHeader
- Set of characteristics shared by all individual transactions
- included in the message.
- $ref: "#/components/schemas/GroupHeader113"
+ Set of characteristics shared by all individual transactions
+ included in the message.
required:
- GrpHdr
example:
@@ -3092,21 +3259,29 @@ components:
FxResponse_FICreditTransferConfirmation:
title: FxResponse_FICreditTransferConfirmation
type: object
+ description: >
+ FxResponse_FICreditTransferConfirmation
+
+ The FxResponse_FICreditTransferConfirmation message is sent by the FSP
+ to the Payer FSP to confirm the successful processing of the credit
+ transfer.
properties:
GrpHdr:
- description: >
- GroupHeader
+ allOf:
+ - $ref: "#/components/schemas/GroupHeader113"
+ - description: >
+ GroupHeader
- Set of characteristics shared by all individual transactions
- included in the message.
- $ref: "#/components/schemas/GroupHeader113"
+ Set of characteristics shared by all individual transactions
+ included in the message.
CdtTrfTxInf:
- description: >
- CreditTransferTransactionInformation
+ allOf:
+ - $ref: "#/components/schemas/CreditTransferTransaction68"
+ - description: >
+ CreditTransferTransactionInformation
- Set of elements providing information specific to the individual
- credit transfer(s).
- $ref: "#/components/schemas/CreditTransferTransaction68"
+ Set of elements providing information specific to the individual
+ credit transfer(s).
required:
- GrpHdr
- CdtTrfTxInf
@@ -3184,21 +3359,29 @@ components:
Fxecute_FinancialInstitutionCreditTransferV12:
title: Fxecute_FinancialInstitutionCreditTransferV12
type: object
+ description: >
+ The Fxecute FinancialInstitutionCreditTransfer message is sent by the
+ initiating party to the executing party to request the execution of a
+ payment. It is used to request movement of funds from the debtor account
+ to the creditor account. The message can carry multiple credit transfer
+ instructions.
properties:
GrpHdr:
- description: >
- GroupHeader.
+ allOf:
+ - $ref: "#/components/schemas/GroupHeader129"
+ - description: >
+ GroupHeader.
- Set of characteristics shared by all individual transactions
- included in the message.
- $ref: "#/components/schemas/GroupHeader129"
+ Set of characteristics shared by all individual transactions
+ included in the message.
CdtTrfTxInf:
- description: >
- CreditTransferTransactionInformation.
+ allOf:
+ - $ref: "#/components/schemas/CreditTransferTransaction68"
+ - description: >
+ CreditTransferTransactionInformation.
- Set of elements providing information specific to the individual
- credit transfer(s).
- $ref: "#/components/schemas/CreditTransferTransaction68"
+ Set of elements providing information specific to the individual
+ credit transfer(s).
required:
- GrpHdr
- CdtTrfTxInf
@@ -3252,22 +3435,30 @@ components:
GenericAccountIdentification1:
title: GenericAccountIdentification1
type: object
+ description: >
+ GenericAccountIdentification
+
+ Unique and unambiguous identification of an account, as assigned by the
+ account servicer.
properties:
Id:
- description: |
- Identification
- Identification assigned by an institution.
- $ref: "#/components/schemas/Max34Text"
+ allOf:
+ - $ref: "#/components/schemas/Max34Text"
+ - description: |
+ Identification
+ Identification assigned by an institution.
SchmeNm:
- description: |
- SchemeName
- Name of the identification scheme.
- $ref: "#/components/schemas/AccountSchemeName1Choice"
+ allOf:
+ - $ref: "#/components/schemas/AccountSchemeName1Choice"
+ - description: |
+ SchemeName
+ Name of the identification scheme.
Issr:
- description: |
- Issuer
- Entity that assigns the identification.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Issuer
+ Entity that assigns the identification.
required:
- Id
example:
@@ -3278,22 +3469,30 @@ components:
GenericFinancialIdentification1:
title: GenericFinancialIdentification1
type: object
+ description: >
+ GenericFinancialIdentification
+
+ Unique and unambiguous identification of a person, which is used to
+ refer to a person in a financial context.
properties:
Id:
- description: |
- Identification
- Unique and unambiguous identification of a person.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Identification
+ Unique and unambiguous identification of a person.
SchmeNm:
- description: |
- SchemeName
- Name of the identification scheme.
- $ref: "#/components/schemas/FinancialIdentificationSchemeName1Choice"
+ allOf:
+ - $ref: "#/components/schemas/FinancialIdentificationSchemeName1Choice"
+ - description: |
+ SchemeName
+ Name of the identification scheme.
Issr:
- description: |
- Issuer
- Entity that assigns the identification.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Issuer
+ Entity that assigns the identification.
required:
- Id
example:
@@ -3304,19 +3503,23 @@ components:
GenericIdentification3:
title: GenericIdentification3
type: object
+ description: |
+ Generic scheme identification for a party.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Identification
- Name or number assigned by an entity to enable recognition of that
- entity, for example, account identifier.
- $ref: "#/components/schemas/Max35Text"
+ Name or number assigned by an entity to enable recognition of
+ that entity, for example, account identifier.
Issr:
- description: |
- Issuer
- Entity that assigns the identification.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Issuer
+ Entity that assigns the identification.
required:
- Id
example:
@@ -3325,24 +3528,29 @@ components:
GenericIdentification30:
title: GenericIdentification30
type: object
+ description: |
+ Generic scheme identification for a party.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: "#/components/schemas/Exact4AlphaNumericText"
+ - description: >
+ Identification
- Proprietary information, often a code, issued by the data source
- scheme issuer
- $ref: "#/components/schemas/Exact4AlphaNumericText"
+ Proprietary information, often a code, issued by the data source
+ scheme issuer.
Issr:
- description: |
- Issuer
- Entity that assigns the identification.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Issuer
+ Entity that assigns the identification.
SchmeNm:
- description: |
- SchemeName
- Short textual description of the scheme.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ SchemeName
+ Short textual description of the scheme.
required:
- Id
- Issr
@@ -3353,22 +3561,28 @@ components:
GenericOrganisationIdentification1:
title: GenericOrganisationIdentification1
type: object
+ description: |
+ Information that locates and identifies an organisation.
properties:
Id:
- description: |
- Identification
- Identification assigned by an institution.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Identification for an organisation. FSPIOP equivalent to Party
+ Identifier for an organisation in ISO 20022. Identification
+ assigned by an institution.
SchmeNm:
- description: |
- SchemeName
- Name of the identification scheme.
- $ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice"
+ allOf:
+ - $ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice"
+ - description: |
+ SchemeName
+ Name of the identification scheme.
Issr:
- description: |
- Issuer
- Entity that assigns the identification.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Issuer
+ Entity that assigns the identification.
required:
- Id
example:
@@ -3379,22 +3593,27 @@ components:
GenericOrganisationIdentification3:
title: GenericOrganisationIdentification3
type: object
+ description: |
+ Information related to an identification of an organisation.
properties:
Id:
- description: |
- Identification
- Identification assigned by an institution.
- $ref: "#/components/schemas/Max256Text"
+ allOf:
+ - $ref: "#/components/schemas/Max256Text"
+ - description: |
+ Identification
+ Identification assigned by an institution.
SchmeNm:
- description: |-
- SchemeName
- Name of the identification scheme.
- $ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice"
+ allOf:
+ - $ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice"
+ - description: |
+ SchemeName
+ Name of the identification scheme.
Issr:
- description: |
- Issuer
- Entity that assigns the identification.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Issuer
+ Entity that assigns the identification.
required:
- Id
example:
@@ -3405,22 +3624,28 @@ components:
GenericPersonIdentification1:
title: GenericPersonIdentification1
type: object
+ description: |
+ GenericPersonIdentification1
+ Information that locates and identifies a specific person.
properties:
Id:
- description: |
- Identification
- Unique and unambiguous identification of a person.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Identification
+ Unique and unambiguous identification of a person.
SchmeNm:
- description: |
- SchemeName
- Name of the identification scheme.
- $ref: "#/components/schemas/PersonIdentificationSchemeName1Choice"
+ allOf:
+ - $ref: "#/components/schemas/PersonIdentificationSchemeName1Choice"
+ - description: |
+ SchemeName
+ Name of the identification scheme.
Issr:
- description: |
- Issuer
- Entity that assigns the identification.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Issuer
+ Entity that assigns the identification.
required:
- Id
example:
@@ -3431,22 +3656,26 @@ components:
GenericPersonIdentification2:
title: GenericPersonIdentification2
type: object
+ description: Identification of a person.
properties:
Id:
- description: |
- Identification
- Unique and unambiguous identification of a person.
- $ref: "#/components/schemas/Max256Text"
+ allOf:
+ - $ref: "#/components/schemas/Max256Text"
+ - description: |
+ Identification
+ Unique and unambiguous identification of a person.
SchmeNm:
- description: |
- SchemeName
- Name of the identification scheme.
- $ref: "#/components/schemas/PersonIdentificationSchemeName1Choice"
+ allOf:
+ - $ref: "#/components/schemas/PersonIdentificationSchemeName1Choice"
+ - description: |
+ SchemeName
+ Name of the identification scheme.
Issr:
- description: |
- Issuer
- Entity that assigns the identification.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Issuer
+ Entity that assigns the identification.
required:
- Id
example:
@@ -3459,24 +3688,27 @@ components:
type: object
properties:
Assgnmt:
- description: |
- Assignment
- Information related to the identification assignment.
- $ref: "#/components/schemas/IdentificationAssignment3"
+ allOf:
+ - $ref: "#/components/schemas/IdentificationAssignment3"
+ - description: |
+ Assignment
+ Information related to the identification assignment.
Rpt:
- description: >
- Report
+ allOf:
+ - $ref: "#/components/schemas/VerificationReport4"
+ - description: >
+ Report
- Information concerning the verification of the identification data
- for which verification was requested.
- $ref: "#/components/schemas/VerificationReport4"
+ Information concerning the verification of the identification
+ data for which verification was requested.
SplmtryData:
- description: >
- SupplementaryData
+ allOf:
+ - $ref: "#/components/schemas/SupplementaryData1"
+ - description: >
+ SupplementaryData
- Additional information that cannot be captured in the structured
- elements and/or any other specific block.
- $ref: "#/components/schemas/SupplementaryData1"
+ Additional information that cannot be captured in the structured
+ elements and/or any other specific block.
required:
- Assgnmt
- Rpt
@@ -3530,24 +3762,27 @@ components:
type: object
properties:
Assgnmt:
- description: |
- Assignment
- Identifies the identification assignment.
- $ref: "#/components/schemas/IdentificationAssignment3"
+ allOf:
+ - $ref: "#/components/schemas/IdentificationAssignment3"
+ - description: |
+ Assignment
+ Identifies the identification assignment.
Rpt:
- description: >
- Report
+ allOf:
+ - $ref: "#/components/schemas/VerificationReport4"
+ - description: >
+ Report
- Information concerning the verification of the identification data
- for which verification was requested.
- $ref: "#/components/schemas/VerificationReport4"
+ Information concerning the verification of the identification
+ data for which verification was requested.
SplmtryData:
- description: >
- SupplementaryData
+ allOf:
+ - $ref: "#/components/schemas/SupplementaryData1"
+ - description: >
+ SupplementaryData
- Additional information that cannot be captured in the structured
- elements and/or any other specific block.
- $ref: "#/components/schemas/SupplementaryData1"
+ Additional information that cannot be captured in the structured
+ elements and/or any other specific block.
required:
- Assgnmt
- Rpt
@@ -3611,19 +3846,40 @@ components:
type: object
properties:
MsgId:
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Message Identification
CreDtTm:
- $ref: "#/components/schemas/ISODateTime"
+ allOf:
+ - $ref: "#/components/schemas/ISODateTime"
+ - description: |
+ Creation Date and Time
NbOfTxs:
- $ref: "#/components/schemas/Max15NumericText"
+ allOf:
+ - $ref: "#/components/schemas/Max15NumericText"
+ - description: |
+ Number of Transactions
TtlIntrBkSttlmAmt:
- $ref: "#/components/schemas/ActiveCurrencyAndAmount"
+ allOf:
+ - $ref: "#/components/schemas/ActiveCurrencyAndAmount"
+ - description: |
+ Total Interbank Settlement Amount
SttlmInf:
- $ref: "#/components/schemas/SettlementInstruction15"
+ allOf:
+ - $ref: "#/components/schemas/SettlementInstruction15"
+ - description: |
+ Settlement Information
PmtTpInf:
- $ref: "#/components/schemas/PaymentTypeInformation28"
+ allOf:
+ - $ref: "#/components/schemas/PaymentTypeInformation28"
+ - description: |
+ Payment Type Information
CdtTrfTxInf:
- $ref: "#/components/schemas/CreditTransferTransaction68"
+ allOf:
+ - $ref: "#/components/schemas/CreditTransferTransaction68"
+ - description: |
+ Credit Transfer Transaction Information
required:
- MsgId
- CreDtTm
@@ -3684,33 +3940,36 @@ components:
type: object
properties:
MsgId:
- description: >
- MessageIdentification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ MessageIdentification
- Definition: Point to point reference, as assigned by the instructing
- party, and sent to the next party in the chain to unambiguously
- identify the message.
+ Definition: Point to point reference, as assigned by the
+ instructing party, and sent to the next party in the chain to
+ unambiguously identify the message.
- Usage: The instructing party has to make sure that
- MessageIdentification is unique per instructed party for a
- pre-agreed period.
- $ref: "#/components/schemas/Max35Text"
+ Usage: The instructing party has to make sure that
+ MessageIdentification is unique per instructed party for a
+ pre-agreed period.
CreDtTm:
- description: |
- CreationDateTime
- Date and time at which the message was created.
- $ref: "#/components/schemas/ISODateTime"
+ allOf:
+ - $ref: "#/components/schemas/ISODateTime"
+ - description: |
+ CreationDateTime
+ Date and time at which the message was created.
TxInfAndSts:
- description: >
- TransactionInformationAndStatus
+ allOf:
+ - $ref: "#/components/schemas/PaymentTransaction163"
+ - description: >
+ TransactionInformationAndStatus
- Definition: Agent that instructs the next party in the chain to
- carry out the (set of) instruction(s).
+ Definition: Agent that instructs the next party in the chain to
+ carry out the (set of) instruction(s).
- Usage: The instructing agent is the party sending the status message
- and not the party that sent the original instruction that is being
- reported on.
- $ref: "#/components/schemas/PaymentTransaction163"
+ Usage: The instructing agent is the party sending the status
+ message and not the party that sent the original instruction
+ that is being reported on.
required:
- MsgId
- CreDtTm
@@ -3737,22 +3996,40 @@ components:
GroupHeader129:
title: GroupHeader129
description: >
- Set of characteristics shared by all individual transactions included in
- the message.
+ Group Header Set of characteristics shared by all individual
+ transactions included in the message.
type: object
properties:
MsgId:
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Message Identification
CreDtTm:
- $ref: "#/components/schemas/ISODateTime"
+ allOf:
+ - $ref: "#/components/schemas/ISODateTime"
+ - description: |
+ Creation Date and Time
PmtInstrXpryDtTm:
- $ref: "#/components/schemas/ISODateTime"
+ allOf:
+ - $ref: "#/components/schemas/ISODateTime"
+ - description: |
+ Payment Instruction Expiry Date and Time
NbOfTxs:
- $ref: "#/components/schemas/Max15NumericText"
+ allOf:
+ - $ref: "#/components/schemas/Max15NumericText"
+ - description: |
+ Number of Transactions
SttlmInf:
- $ref: "#/components/schemas/SettlementInstruction15"
+ allOf:
+ - $ref: "#/components/schemas/SettlementInstruction15"
+ - description: |
+ Settlement Information
CdtTrfTxInf:
- $ref: "#/components/schemas/CreditTransferTransaction67"
+ allOf:
+ - $ref: "#/components/schemas/CreditTransferTransaction67"
+ - description: |
+ Credit Transfer Transaction Information
required:
- MsgId
- CreDtTm
@@ -3862,28 +4139,44 @@ components:
IdentificationAssignment3:
title: IdentificationAssignment3
type: object
+ description: >
+ IdentificationAssignment
+
+ Information that unambiguously identifies a message, as assigned by the
+ assignor to the assignee.
properties:
MsgId:
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ MessageIdentification
+
+ Unique identification, as assigned by the assigner, to
+ unambiguously identify the message.
CreDtTm:
- description: |
- CreationDateTime
- Date and time at which the identification assignment was created.
- $ref: "#/components/schemas/ISODateTime"
+ allOf:
+ - $ref: "#/components/schemas/ISODateTime"
+ - description: >
+ CreationDateTime
+
+ Date and time at which the identification assignment was
+ created.
Assgnr:
- description: >
- Assignor
+ allOf:
+ - $ref: "#/components/schemas/Party40Choice"
+ - description: >
+ Assignor
- Party that assigns the identification assignment to another party.
- This is also the sender of the message.
- $ref: "#/components/schemas/Party40Choice"
+ Party that assigns the identification assignment to another
+ party. This is also the sender of the message.
Assgne:
- description: >
- Assignee
+ allOf:
+ - $ref: "#/components/schemas/Party40Choice"
+ - description: >
+ Assignee
- Party that the identification assignment is assigned to. This is
- also the receiver of the message.
- $ref: "#/components/schemas/Party40Choice"
+ Party that the identification assignment is assigned to. This is
+ also the receiver of the message.
required:
- MsgId
- CreDtTm
@@ -3909,24 +4202,32 @@ components:
IdentificationInformation4:
title: IdentificationInformation4
type: object
+ description: |
+ Information that locates and identifies a specific party or account.
properties:
Pty:
- description: >
- Party
+ allOf:
+ - $ref: "#/components/schemas/PartyIdentification135"
+ - description: >
+ Party
- Account owner that owes an amount of money or to whom an amount of
- money is due.
- $ref: "#/components/schemas/PartyIdentification135"
+ Account owner that owes an amount of money or to whom an amount
+ of money is due.
Acct:
- description: |
- Account
- Unambiguous identification of the account of a party.
- $ref: "#/components/schemas/CashAccount40"
+ allOf:
+ - $ref: "#/components/schemas/CashAccount40"
+ - description: |
+ Account
+ Unambiguous identification of the account of a party.
Agt:
- description: |
- Agent
- Financial institution servicing an account for a party.
- $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification6"
+ allOf:
+ - $ref: >-
+ #/components/schemas/BranchAndFinancialInstitutionIdentification6
+ - description: |
+ Agent
+ Financial institution servicing an account for a party.
+ required:
+ - Pty
example:
Pty:
Id:
@@ -3958,12 +4259,14 @@ components:
title: Instruction4Code
description: >
Specifies further instructions concerning the processing of a payment
+
instruction, provided by the sending clearing agent to the next
agent(s).
- PHOA PhoneNextAgent Please advise/contact next agent by phone.
- TELA TelecomNextAgent Please advise/contact next agent by the most
+ PHOA: PhoneNextAgent Please advise/contact next agent by phone.
+
+ TELA: TelecomNextAgent Please advise/contact next agent by the most
efficient means of telecommunication.
type: string
enum:
@@ -3979,21 +4282,23 @@ components:
type: object
properties:
Cd:
- description: >
- Code
-
- Coded information related to the processing of the payment
- instruction, provided by the initiating party, and intended for the
- creditor's agent.
- $ref: "#/components/schemas/ExternalCreditorAgentInstruction1Code"
+ allOf:
+ - $ref: "#/components/schemas/ExternalCreditorAgentInstruction1Code"
+ - description: >
+ Code
+
+ Coded information related to the processing of the payment
+ instruction, provided by the initiating party, and intended for
+ the creditor's agent.
InstrInf:
- description: >
- InstructionInformation
-
- Further information complementing the coded instruction or
- instruction to the creditor's agent that is bilaterally agreed or
- specific to a user community.
- $ref: "#/components/schemas/Max140Text"
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: >
+ InstructionInformation
+
+ Further information complementing the coded instruction or
+ instruction to the creditor's agent that is bilaterally agreed
+ or specific to a user community.
example:
Cd: PHOA
InstrInf: Please advise/contact next agent by phone.
@@ -4001,29 +4306,31 @@ components:
title: InstructionForNextAgent1
description: >
Further information related to the processing of the payment
- instruction, provided by the initiating party, and intended for the
- creditor agent.
+ instruction, provided by the initiating party, and intended for the next
+ agent in the payment chain.
type: object
properties:
Cd:
- description: >
- Code
-
- Coded information related to the processing of the payment
- instruction, provided by the initiating party, and intended for the
- next agent in the payment chain.
- $ref: "#/components/schemas/Instruction4Code"
+ allOf:
+ - $ref: "#/components/schemas/Instruction4Code"
+ - description: >
+ Code
+
+ Coded information related to the processing of the payment
+ instruction, provided by the initiating party, and intended for
+ the next agent in the payment chain.
InstrInf:
- description: >
- InstructionInformation
-
- Further information complementing the coded instruction or
- instruction to the next agent that is bilaterally agreed or specific
- to a user community.
- $ref: "#/components/schemas/Max140Text"
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: >
+ InstructionInformation
+
+ Further information complementing the coded instruction or
+ instruction to the next agent that is bilaterally agreed or
+ specific to a user community.
example:
Cd: PHOA
- InstrInf: Please advise/contact next agent by phone
+ InstrInf: Please advise/contact next agent by phone.
LEIIdentifier:
title: LEIIdentifier
description: >
@@ -4036,23 +4343,29 @@ components:
LocalInstrument2Choice:
title: LocalInstrument2Choice
type: object
- properties:
- Cd:
- description: >
- Code
-
- Specifies the local instrument, as published in an external local
- instrument code list.
- $ref: "#/components/schemas/ExternalLocalInstrument1Code"
- Prtry:
- description: |
- Proprietary
- Specifies the local instrument, as a proprietary code
- $ref: "#/components/schemas/Max35Text"
+ description: >
+ Specifies the local instrument, as published in an external local
+ instrument code list or as a proprietary code.
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/ExternalLocalInstrument1Code"
+ - description: >
+ Code
+
+ Specifies the local instrument, as published in an external
+ local instrument code list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Proprietary
+ Specifies the local instrument, as a proprietary code.
+ required:
- Prtry
example:
Cd: CH03
@@ -4162,6 +4475,12 @@ components:
NamePrefix2Code:
description: |
Specifies the terms used to formally address a person.
+
+ DOCT: Doctor or Dr
+ MADM: Madam
+ MISS: Miss
+ MIST: Mistress
+ MIKS: Mx
enum:
- DOCT
- MADM
@@ -4182,24 +4501,27 @@ components:
type: object
properties:
AnyBIC:
- description: |
- AnyBIC
- Business identification code of the organisation.
- $ref: "#/components/schemas/AnyBICDec2014Identifier"
+ allOf:
+ - $ref: "#/components/schemas/AnyBICDec2014Identifier"
+ - description: |
+ AnyBIC
+ Business identification code of the organisation.
LEI:
- description: >
- LEI
+ allOf:
+ - $ref: "#/components/schemas/LEIIdentifier"
+ - description: >
+ LEI
- Legal entity identification as an alternate identification for a
- party.
- $ref: "#/components/schemas/LEIIdentifier"
+ Legal entity identification as an alternate identification for a
+ party.
Othr:
- description: >
- Other
+ allOf:
+ - $ref: "#/components/schemas/GenericOrganisationIdentification1"
+ - description: >
+ Other
- Unique identification of an organisation, as assigned by an
- institution, using an identification scheme.
- $ref: "#/components/schemas/GenericOrganisationIdentification1"
+ Unique identification of an organisation, as assigned by an
+ institution, using an identification scheme.
example:
AnyBIC: BICFI
LEI: 529900T8BM49AURSDO55
@@ -4215,24 +4537,27 @@ components:
type: object
properties:
AnyBIC:
- description: |
- AnyBIC
- Business identification code of the organisation.
- $ref: "#/components/schemas/AnyBICDec2014Identifier"
+ allOf:
+ - $ref: "#/components/schemas/AnyBICDec2014Identifier"
+ - description: |
+ AnyBIC
+ Business identification code of the organisation.
LEI:
- description: >
- LEI
+ allOf:
+ - $ref: "#/components/schemas/LEIIdentifier"
+ - description: >
+ LEI
- Legal entity identification as an alternate identification for a
- party.
- $ref: "#/components/schemas/LEIIdentifier"
+ Legal entity identification as an alternate identification for a
+ party.
Othr:
- description: >
- Other
+ allOf:
+ - $ref: "#/components/schemas/GenericOrganisationIdentification3"
+ - description: >
+ Other
- Unique identification of an organisation, as assigned by an
- institution, using an identification scheme.
- $ref: "#/components/schemas/GenericOrganisationIdentification3"
+ Unique identification of an organisation, as assigned by an
+ institution, using an identification scheme.
example:
AnyBIC: BICFI
LEI: 529900T8BM49AURSDO55
@@ -4248,22 +4573,24 @@ components:
type: object
properties:
Cd:
- description: >
- Code
+ allOf:
+ - $ref: "#/components/schemas/ExternalOrganisationIdentification1Code"
+ - description: >
+ Code
- Name of the identification scheme, in a coded form as published in
- an external list.
- $ref: "#/components/schemas/ExternalOrganisationIdentification1Code"
+ Name of the identification scheme, in a coded form as published
+ in an external list.
Prtry:
- description: |
- Proprietary
- Name of the identification scheme, in a free text form.
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Proprietary
+ Name of the identification scheme, in a free text form.
oneOf:
- - required:
- - Cd
- - required:
- - Prtry
+ - properties:
+ Cd: {}
+ - properties:
+ Prtry: {}
example:
Cd: BIC
OtherContact1:
@@ -4274,17 +4601,19 @@ components:
type: object
properties:
ChanlTp:
- description: >
- ChannelType
+ allOf:
+ - $ref: "#/components/schemas/Max4Text"
+ - description: >
+ ChannelType
- Method used to contact the financial institution's contact for the
- specific tax region.
- $ref: "#/components/schemas/Max4Text"
+ Method used to contact the financial institution's contact for
+ the specific tax region.
Id:
- description: |
- Identifier
- Communication value such as phone number or email address.
- $ref: "#/components/schemas/Max128Text"
+ allOf:
+ - $ref: "#/components/schemas/Max128Text"
+ - description: |
+ Identifier
+ Communication value such as phone number or email address.
required:
- ChanlTp
example:
@@ -4293,13 +4622,29 @@ components:
PacsError_FIToFIPaymentStatusReportV15:
title: PacsError_FIToFIPaymentStatusReportV15
type: object
+ description: >
+ This message is sent by an account servicing institution to an account
+ owner. It is used to inform the account owner about the status of a
+ payment initiation.
properties:
GrpHdr:
- $ref: "#/components/schemas/GroupHeader120"
+ allOf:
+ - $ref: "#/components/schemas/GroupHeader120"
+ - description: >
+ Set of characteristics shared by all individual transactions
+ included in the message.
TxInfAndSts:
- $ref: "#/components/schemas/PaymentTransaction163"
+ allOf:
+ - $ref: "#/components/schemas/PaymentTransaction163"
+ - description: >
+ Information concerning the original transactions, to which the
+ status report message refers.
SplmtryData:
- $ref: "#/components/schemas/SupplementaryData1"
+ allOf:
+ - $ref: "#/components/schemas/SupplementaryData1"
+ - description: >
+ Additional information that cannot be captured in the structured
+ elements and/or any other specific block.
required:
- GrpHdr
example:
@@ -4328,12 +4673,19 @@ components:
Envlp: ENVELOPE
PacsStatus_FIToFIPaymentStatusReportV15:
title: PacsStatus_FIToFIPaymentStatusReportV15
- description: |
- Unsure on description.
+ description: >-
+ The PacsStatus message is sent by a financial institution to another
+ financial institution as a response to the FIToFIPaymentStatusReport
+ message. The message provides information on the status of a payment
+ instruction and its underlying individual transactions.
type: object
properties:
GrpHdr:
- $ref: "#/components/schemas/GroupHeader120"
+ allOf:
+ - $ref: "#/components/schemas/GroupHeader120"
+ - description: >
+ Set of characteristics shared by all individual transactions
+ included in the message.
required:
- GrpHdr
example:
@@ -4362,23 +4714,26 @@ components:
description: |
Nature or use of the account.
type: object
- properties:
- OrgId:
- description: |
- Organisation
- Unique and unambiguous way to identify an organisation.
- $ref: "#/components/schemas/OrganisationIdentification29"
- PrvtId:
- description: >
- PrivateIdentification
-
- Unique and unambiguous identification of a person, for example a
- passport.
- $ref: "#/components/schemas/PersonIdentification13"
oneOf:
- - required:
+ - properties:
+ OrgId:
+ allOf:
+ - $ref: "#/components/schemas/OrganisationIdentification29"
+ - description: |
+ Organisation
+ Unique and unambiguous way to identify an organisation.
+ required:
- OrgId
- - required:
+ - properties:
+ PrvtId:
+ allOf:
+ - $ref: "#/components/schemas/PersonIdentification13"
+ - description: >
+ PrivateIdentification
+
+ Unique and unambiguous identification of a person, for
+ example a passport.
+ required:
- PrvtId
example:
OrgId:
@@ -4392,21 +4747,25 @@ components:
description: |
Identification of a person, an organisation or a financial institution.
type: object
- properties:
- Pty:
- description: |
- Party
- Identification of a person or an organisation.
- $ref: "#/components/schemas/PartyIdentification135"
- Agt:
- description: |
- Agent
- Identification of a financial institution.
- $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification6"
oneOf:
- - required:
+ - properties:
+ Pty:
+ allOf:
+ - $ref: "#/components/schemas/PartyIdentification135"
+ - description: |
+ Party
+ Identification of a person or an organisation.
+ required:
- Pty
- - required:
+ - properties:
+ Agt:
+ allOf:
+ - $ref: >-
+ #/components/schemas/BranchAndFinancialInstitutionIdentification6
+ - description: |
+ Agent
+ Identification of a financial institution.
+ required:
- Agt
example:
Pty:
@@ -4436,23 +4795,26 @@ components:
description: |
NOTE: Unsure on the description.
type: object
- properties:
- OrgId:
- description: |
- Organisation
- Unique and unambiguous way to identify an organisation.
- $ref: "#/components/schemas/OrganisationIdentification39"
- PrvtId:
- description: >
- Person
-
- Unique and unambiguous identification of a person, for example a
- passport
- $ref: "#/components/schemas/PersonIdentification18"
oneOf:
- - required:
+ - properties:
+ OrgId:
+ allOf:
+ - $ref: "#/components/schemas/OrganisationIdentification39"
+ - description: |
+ Organisation
+ Unique and unambiguous way to identify an organisation.
+ required:
- OrgId
- - required:
+ - properties:
+ PrvtId:
+ allOf:
+ - $ref: "#/components/schemas/PersonIdentification18"
+ - description: >
+ Person
+
+ Unique and unambiguous identification of a person, for
+ example a passport.
+ required:
- PrvtId
example:
OrgId:
@@ -4468,35 +4830,44 @@ components:
type: object
properties:
Nm:
- description: >
- Name
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: >
+ Name
- Name by which a party is known and which is usually used to identify
- that party.
- $ref: "#/components/schemas/Max140Text"
+ Name by which a party is known and which is usually used to
+ identify that party.
PstlAdr:
- description: >
- PostalAddress
+ allOf:
+ - $ref: "#/components/schemas/PostalAddress24"
+ - description: >
+ PostalAddress
- Information that locates and identifies a specific address, as
- defined by postal services.
- $ref: "#/components/schemas/PostalAddress24"
+ Information that locates and identifies a specific address, as
+ defined by postal services.
Id:
- description: |
- Identification
- Unique and unambiguous way to identify an organisation.
- $ref: "#/components/schemas/Party38Choice"
+ allOf:
+ - $ref: "#/components/schemas/Party38Choice"
+ - description: |
+ Identification
+ Unique and unambiguous way to identify an organisation.
CtryOfRes:
- description: >
- CountryOfResidence Country in which a person resides (the place of a
- person's home). In the case of a company, it is the country from
- which the affairs of that company are directed.
- $ref: "#/components/schemas/CountryCode"
+ allOf:
+ - $ref: "#/components/schemas/CountryCode"
+ - description: >
+ CountryOfResidence
+
+ Country in which a person resides (the place of a person's
+ home). In the case of a company, it is the country from which
+ the affairs of that company are directed.
CtctDtls:
- description: |
- ContactDetails
- Set of elements used to indicate how to contact the party.
- $ref: "#/components/schemas/Contact4"
+ allOf:
+ - $ref: "#/components/schemas/Contact4"
+ - description: |
+ ContactDetails
+ Set of elements used to indicate how to contact the party.
+ required:
+ - Id
example:
Nm: John Doe
PstlAdr:
@@ -4537,37 +4908,44 @@ components:
type: object
properties:
Nm:
- description: >
- Name
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: >
+ Name
- Name by which a party is known and which is usually used to identify
- that party.
- $ref: "#/components/schemas/Max140Text"
+ Name by which a party is known and which is usually used to
+ identify that party.
PstlAdr:
- description: >
- Postal Address
+ allOf:
+ - $ref: "#/components/schemas/PostalAddress27"
+ - description: >
+ Postal Address
- Information that locates and identifies a specific address, as
- defined by postal services.
- $ref: "#/components/schemas/PostalAddress27"
+ Information that locates and identifies a specific address, as
+ defined by postal services.
Id:
- description: |
- Identification
- Unique and unambiguous identification of a party.
- $ref: "#/components/schemas/Party52Choice"
+ allOf:
+ - $ref: "#/components/schemas/Party52Choice"
+ - description: |
+ Identification
+ Unique and unambiguous identification of a party.
CtryOfRes:
- description: >
- Country of Residence
-
- Country in which a person resides (the place of a person's home). In
- the case of a company, it is the country from which the affairs of
- that company are directed.
- $ref: "#/components/schemas/CountryCode"
+ allOf:
+ - $ref: "#/components/schemas/CountryCode"
+ - description: >
+ Country of Residence
+
+ Country in which a person resides (the place of a person's
+ home). In the case of a company, it is the country from which
+ the affairs of that company are directed.
CtctDtls:
- description: |
- Contact Details
- Set of elements used to indicate how to contact the party.
- $ref: "#/components/schemas/Contact13"
+ allOf:
+ - $ref: "#/components/schemas/Contact13"
+ - description: |
+ Contact Details
+ Set of elements used to indicate how to contact the party.
+ required:
+ - Id
example:
Nm: John Doe
PstlAdr:
@@ -4594,7 +4972,7 @@ components:
PhneNb: +123-123-321
MobNb: +123-123-321
FaxNb: +123-123-321
- EmailAdr: null
+ EmailAdr: example@example.com
PaymentIdentification13:
title: PaymentIdentification13
description: |
@@ -4602,66 +4980,92 @@ components:
type: object
properties:
InstrId:
- description: >
- InstructionIdentification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ InstructionIdentification (FSPIOP equivalent:
+ transactionRequestId)
- Definition: Unique identification, as assigned by an instructing
- party for an instructed party, to unambiguously identify the
- instruction.
- Usage: The instruction identification is a point to point reference
- that can be used between the instructing party and the instructed
- party to refer to the individual instruction. It can be included in
- several messages related to the instruction.
- $ref: "#/components/schemas/Max35Text"
+ Definition: Unique identification, as assigned by an instructing
+ party for an instructed party, to
+
+ unambiguously identify the instruction.
+
+
+ Usage: The instruction identification is a point to point
+ reference that can be used between the
+
+ instructing party and the instructed party to refer to the
+ individual instruction. It can be included in
+
+ several messages related to the instruction.
EndToEndId:
- description: >
- EndToEndIdentification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ EndToEndIdentification (FSPIOP equivalent: transactionId)
- Definition: Unique identification, as assigned by the initiating
- party, to unambiguously identify the transaction. This
- identification is passed on, unchanged, throughout the entire
- end-to-end chain.
- Usage: The end-to-end identification can be used for reconciliation
- or to link tasks relating to the transaction. It can be included in
- several messages related to the transaction.
+ Definition: Unique identification, as assigned by the initiating
+ party, to unambiguously identify the
- Usage: In case there are technical limitations to pass on multiple
- references, the end-to-end identification must be passed on
- throughout the entire end-to-end chain.
- $ref: "#/components/schemas/Max35Text"
+ transaction. This identification is passed on, unchanged,
+ throughout the entire end-to-end chain.
+
+
+ Usage: The end-to-end identification can be used for
+ reconciliation or to link tasks relating to the
+
+ transaction. It can be included in several messages related to
+ the transaction.
+
+
+ Usage: In case there are technical limitations to pass on
+ multiple references, the end-to-end
+
+ identification must be passed on throughout the entire
+ end-to-end chain.
TxId:
- description: >
- TransactionIdentification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ TransactionIdentification (FSPIOP equivalent: quoteId)
- Definition: Unique identification, as assigned by the first
- instructing agent, to unambiguously identify the transaction that is
- passed on, unchanged, throughout the entire interbank chain.
- Usage: The transaction identification can be used for
- reconciliation, tracking or to link tasks relating to the
- transaction on the interbank level.
+ Definition: Unique identification, as assigned by the first
+ instructing agent, to unambiguously identify the
- Usage: The instructing agent has to make sure that the transaction
- identification is unique for a preagreed period.
- $ref: "#/components/schemas/Max35Text"
+ transaction that is passed on, unchanged, throughout the entire
+ interbank chain.
+
+
+ Usage: The transaction identification can be used for
+ reconciliation, tracking or to link tasks relating to
+
+ the transaction on the interbank level.
+
+
+ Usage: The instructing agent has to make sure that the
+ transaction identification is unique for a preagreed period.
UETR:
- description: >
- UETR
+ allOf:
+ - $ref: "#/components/schemas/UUIDv4Identifier"
+ - description: >
+ UETR
- Universally unique identifier to provide an end-to-end reference of
- a payment transaction.
- $ref: "#/components/schemas/UUIDv4Identifier"
+ Universally unique identifier to provide an end-to-end reference
+ of a payment transaction.
ClrSysRef:
- description: >
- ClearingSystemReference
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ ClearingSystemReference
- Unique reference, as assigned by a clearing system, to unambiguously
- identify the instruction.
- $ref: "#/components/schemas/Max35Text"
+ Unique reference, as assigned by a clearing system, to
+ unambiguously identify the instruction.
required:
- - EndToEndId
+ - TxId
example:
InstrId: INSTRUCTIONID
EndToEndId: ENDTOENDID
@@ -4676,29 +5080,91 @@ components:
type: object
properties:
StsId:
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Unique identification, as assigned by the original sending
+ party, to unambiguously identify the status report.
OrgnlInstrId:
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Unique identification, as assigned by the original sending
+ party, to
+
+ unambiguously identify the original instruction.
+
+
+ (FSPIOP equivalent: transactionRequestId)
OrgnlEndToEndId:
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Unique identification, as assigned by the original sending
+ party, to
+
+ unambiguously identify the original end-to-end transaction.
+
+
+ (FSPIOP equivalent: transactionId)
OrgnlTxId:
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Unique identification, as assigned by the original sending
+ party, to
+
+ unambiguously identify the original transaction.
+
+
+ (FSPIOP equivalent: quoteId)
OrgnlUETR:
- $ref: "#/components/schemas/UUIDv4Identifier"
+ allOf:
+ - $ref: "#/components/schemas/UUIDv4Identifier"
+ - description: >
+ Unique end-to-end transaction reference, as assigned by the
+ original sending party, to unambiguously identify the original
+ transaction.
TxSts:
- $ref: "#/components/schemas/ExternalPaymentTransactionStatus1Code"
+ allOf:
+ - $ref: "#/components/schemas/ExternalPaymentTransactionStatus1Code"
+ - description: |
+ Specifies the status of the transaction.
StsRsnInf:
- $ref: "#/components/schemas/StatusReasonInformation14"
+ allOf:
+ - $ref: "#/components/schemas/StatusReasonInformation14"
+ - description: |
+ Information concerning the reason for the status.
AccptncDtTm:
- $ref: "#/components/schemas/ISODateTime"
+ allOf:
+ - $ref: "#/components/schemas/ISODateTime"
+ - description: |
+ Date and time at which the status was accepted.
AcctSvcrRef:
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Unique reference, as assigned by the account servicing
+ institution, to unambiguously identify the status report.
ClrSysRef:
- $ref: "#/components/schemas/Max35Text"
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Reference that is assigned by the account servicing institution
+ and sent to the account owner to unambiguously identify the
+ transaction.
ExctnConf:
- $ref: "#/components/schemas/Exact32HexBinaryText"
+ allOf:
+ - $ref: "#/components/schemas/Exact32HexBinaryText"
+ - description: >
+ Unique reference, as assigned by the account servicing
+ institution, to unambiguously identify the confirmation.
SplmtryData:
- $ref: "#/components/schemas/SupplementaryData1"
+ allOf:
+ - $ref: "#/components/schemas/SupplementaryData1"
+ - description: >
+ Additional information that cannot be captured in the structured
+ elements and/or any other specific block.
example:
StsId: 12345
OrgnlInstrId: 12345
@@ -4723,43 +5189,36 @@ components:
type: object
properties:
InstrPrty:
- description: >
- InstructionPriority
-
- 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.
$ref: "#/components/schemas/Priority2Code"
ClrChanl:
- description: >
- ClearingChannel
-
- Specifies the clearing channel to be used to process the payment
- instruction.
$ref: "#/components/schemas/ClearingChannel2Code"
SvcLvl:
- description: >
- ServiceLevel
+ allOf:
+ - $ref: "#/components/schemas/ServiceLevel8Choice"
+ - description: >
+ ServiceLevel
- Agreement under which or rules under which the transaction should be
- processed.
- $ref: "#/components/schemas/ServiceLevel8Choice"
+ Agreement under which or rules under which the transaction
+ should be processed.
LclInstrm:
- description: >
- LocalInstrument
+ allOf:
+ - $ref: "#/components/schemas/LocalInstrument2Choice"
+ - description: >
+ LocalInstrument
- Definition: User community specific instrument.
+ Definition: User community specific instrument.
- Usage: This element is used to specify a local instrument, local
- clearing option and/or further qualify the service or service level.
- $ref: "#/components/schemas/LocalInstrument2Choice"
+ Usage: This element is used to specify a local instrument, local
+ clearing option and/or further qualify the service or service
+ level.
CtgyPurp:
- description: >
- CategoryPurpose
+ allOf:
+ - $ref: "#/components/schemas/CategoryPurpose1Choice"
+ - description: >
+ CategoryPurpose
- Specifies the high level purpose of the instruction based on a set
- of pre-defined categories.
- $ref: "#/components/schemas/CategoryPurpose1Choice"
+ Specifies the high level purpose of the instruction based on a
+ set of pre-defined categories.
example:
InstrPrty: NORM
ClrChanl: RTGS
@@ -4781,17 +5240,19 @@ components:
type: object
properties:
DtAndPlcOfBirth:
- description: |
- DateAndPlaceOfBirth
- Date and place of birth of a person.
- $ref: "#/components/schemas/DateAndPlaceOfBirth1"
+ allOf:
+ - $ref: "#/components/schemas/DateAndPlaceOfBirth1"
+ - description: |
+ DateAndPlaceOfBirth
+ Date and place of birth of a person.
Othr:
- description: >
- Other
+ allOf:
+ - $ref: "#/components/schemas/GenericPersonIdentification1"
+ - description: >
+ Other
- Unique identification of a person, as assigned by an institution,
- using an identification scheme.
- $ref: "#/components/schemas/GenericPersonIdentification1"
+ Unique identification of a person, as assigned by an
+ institution, using an identification scheme.
example:
DtAndPlcOfBirth:
Dt: "2018-01-01"
@@ -4808,17 +5269,19 @@ components:
type: object
properties:
DtAndPlcOfBirth:
- description: |
- DateAndPlaceOfBirth
- Date and place of birth of a person.
- $ref: "#/components/schemas/DateAndPlaceOfBirth1"
+ allOf:
+ - $ref: "#/components/schemas/DateAndPlaceOfBirth1"
+ - description: |
+ DateAndPlaceOfBirth
+ Date and place of birth of a person.
Othr:
- description: >
- Other
+ allOf:
+ - $ref: "#/components/schemas/GenericPersonIdentification2"
+ - description: >
+ Other
- Unique identification of a person, as assigned by an institution,
- using an identification scheme.
- $ref: "#/components/schemas/GenericPersonIdentification2"
+ Unique identification of a person, as assigned by an
+ institution, using an identification scheme.
example:
DtAndPlcOfBirth:
Dt: "2018-01-01"
@@ -4833,23 +5296,26 @@ components:
description: |
Sets of elements to identify a name of the identification scheme.
type: object
- properties:
- Cd:
- description: >
- Code
-
- Name of the identification scheme, in a coded form as published in
- an external list
- $ref: "#/components/schemas/ExternalPersonIdentification1Code"
- Prtry:
- description: |
- Proprietary
- Name of the identification scheme, in a free text form
- $ref: "#/components/schemas/Max35Text"
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/ExternalPersonIdentification1Code"
+ - description: >
+ Code
+
+ Name of the identification scheme, in a coded form as
+ published in an external list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Proprietary
+ Name of the identification scheme, in a free text form.
+ required:
- Prtry
example:
Cd: CCPT
@@ -4982,6 +5448,17 @@ components:
description: >
Preferred method used to reach the individual contact within an
organisation.
+
+
+ LETT: Letter
+
+ MAIL: Email
+
+ PHON: Phone
+
+ FAXX: Fax
+
+ CELL: Mobile phone
type: string
enum:
- LETT
@@ -4995,6 +5472,16 @@ components:
description: >
Preferred method used to reach the individual contact within an
organisation.
+
+ LETT: Letter
+
+ MAIL: Email
+
+ PHON: Phone
+
+ FAXX: Fax
+
+ CELL: Mobile phone
type: string
enum:
- LETT
@@ -5007,8 +5494,15 @@ components:
title: Priority2Code
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
+ party
+
+ would like the instructed party to apply to the processing of the
instruction.
+
+
+ HIGH: High priority
+
+ NORM: Normal priority
type: string
enum:
- HIGH
@@ -5021,19 +5515,19 @@ components:
type: object
properties:
Tp:
- description: |
- Type
-
- Type of the proxy identification.
- $ref: "#/components/schemas/ProxyAccountType1Choice"
+ allOf:
+ - $ref: "#/components/schemas/ProxyAccountType1Choice"
+ - description: |
+ Type
+ Type of the proxy identification.
Id:
- description: >
- Identification
-
+ allOf:
+ - $ref: "#/components/schemas/Max2048Text"
+ - description: >
+ Identification
- Identification used to indicate the account identification under
- another specified name.
- $ref: "#/components/schemas/Max2048Text"
+ Identification used to indicate the account identification under
+ another specified name.
required:
- Id
example:
@@ -5042,62 +5536,70 @@ components:
Id: 123
ProxyAccountType1Choice:
title: ProxyAccountType1Choice
- type: object
description: |
- ProxyAccountType1Choice
-
- Specifies the scheme used for the identification of an account alias.
- properties:
- Cd:
- description: >
- Code
-
-
- Name of the identification scheme, in a coded form as published in
- an external list.
- $ref: "#/components/schemas/ExternalProxyAccountType1Code"
- Prtry:
- description: |
- Proprietary
-
- Name of the identification scheme, in a free text form.
- $ref: "#/components/schemas/Max35Text"
+ Specifies the type of the proxy account.
+ type: object
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/ExternalProxyAccountType1Code"
+ - description: >
+ Code
+
+ Proxy account type, in a coded form as published in an
+ external list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Proprietary
+ Proxy account type, in a proprietary form.
+ required:
- Prtry
example:
- Cd: CH03
+ Cd: EMAIL
Purpose2Choice:
title: Purpose2Choice
description: >
Specifies the underlying reason for the payment transaction.
+
Usage: Purpose is used by the end-customers, that is initiating party,
- (ultimate) debtor, (ultimate) creditor to provide information concerning
- the nature of the payment. Purpose is a content element, which is not
- used for processing by any of the agents involved in the payment chain.
- type: object
- properties:
- Cd:
- description: >
- Code
+ (ultimate) debtor, (ultimate) creditor to provide information concerning
+ the nature of the payment. Purpose
- Underlying reason for the payment transaction, as published in an
- external purpose code list.
- $ref: "#/components/schemas/ExternalPurpose1Code"
- Prtry:
- description: |
- Proprietary
+ is a content element, which is not used for processing by any of the
+ agents involved in the payment
- Purpose, in a proprietary form.
- $ref: "#/components/schemas/Max35Text"
+ chain.
+ type: object
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/ExternalPurpose1Code"
+ - description: >
+ Code
+
+
+ Underlying reason for the payment transaction, as published
+ in an external purpose code list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Proprietary
+
+ Purpose, in a proprietary form.
+ required:
- Prtry
example:
Cd: CH03
@@ -5109,19 +5611,23 @@ components:
type: object
properties:
Nm:
- description: |
- Name
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: >
+ Name
- Name of the entity requiring the regulatory reporting information.
- $ref: "#/components/schemas/Max140Text"
+
+ Name of the entity requiring the regulatory reporting
+ information.
Ctry:
- description: >
- Country
+ allOf:
+ - $ref: "#/components/schemas/CountryCode"
+ - description: >
+ Country
- Country of the entity that requires the regulatory reporting
- information.
- $ref: "#/components/schemas/CountryCode"
+ Country of the entity that requires the regulatory reporting
+ information.
example:
Nm: Swiss National Bank
Ctry: CH
@@ -5132,19 +5638,21 @@ components:
type: object
properties:
DbtCdtRptgInd:
- description: >
- DebitCreditReportingIndicator
-
- 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.
- $ref: "#/components/schemas/RegulatoryReportingType1Code"
+ allOf:
+ - $ref: "#/components/schemas/RegulatoryReportingType1Code"
+ - description: >
+ DebitCreditReportingIndicator
+
+ 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.
Authrty:
- description: |
- Authority
+ allOf:
+ - $ref: "#/components/schemas/RegulatoryAuthority2"
+ - description: |
+ Authority
- Entity requiring the regulatory reporting information.
- $ref: "#/components/schemas/RegulatoryAuthority2"
+ Entity requiring the regulatory reporting information.
Dtls:
description: >
Details
@@ -5169,7 +5677,18 @@ components:
title: RegulatoryReportingType1Code
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
+ debit
+
+ side, to the credit side or to both debit and credit sides of the
+ transaction.
+
+
+ CRED: Regulatory reporting applies to the credit side of the
+ transaction.
+
+ DEBT: Regulatory reporting applies to the debit side of the transaction.
+
+ BOTH: Regulatory reporting applies to both debit and credit sides of the
transaction.
type: string
enum:
@@ -5182,25 +5701,29 @@ components:
description: |
Details about a service level.
type: object
- properties:
- Cd:
- description: >
- Code
-
- Specifies a pre-agreed service or level of service between the
- parties, as published in an external service level code list.
- $ref: "#/components/schemas/ExternalServiceLevel1Code"
- Prtry:
- description: >
- Proprietary
-
- Specifies a pre-agreed service or level of service between the
- parties, as a proprietary code.
- $ref: "#/components/schemas/Max35Text"
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/ExternalServiceLevel1Code"
+ - description: >
+ Code
+
+ Specifies a pre-agreed service or level of service between
+ the parties, as published in an external service level code
+ list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Proprietary
+
+ Specifies a pre-agreed service or level of service between
+ the parties, as a proprietary code.
+ required:
- Prtry
example:
Cd: SEPA
@@ -5214,13 +5737,8 @@ components:
type: object
properties:
SttlmMtd:
- description: |
- SettlementMethod
- Method used to settle the (batch of) payment instructions.
$ref: "#/components/schemas/SettlementMethod1Code"
PmtTpInf:
- description: |
- PaymentTypeInformation
$ref: "#/components/schemas/PaymentTypeInformation28"
required:
- SttlmMtd
@@ -5257,6 +5775,11 @@ components:
title: SettlementMethod1Code
description: |
Specifies the method used to settle the credit transfer instruction.
+
+ INDA: Indirect Account
+ INGA: Indirect Agent
+ COVE: Cover
+ CLRG: Clearing
type: string
enum:
- INDA
@@ -5267,23 +5790,28 @@ components:
StatusReason6Choice:
title: StatusReason6Choice
description: |
- Unsure on description.
+ Specifies the reason for the status.
type: object
- properties:
- Cd:
- description: |
- Code
- Reason for the status, as published in an external reason code list.
- $ref: "#/components/schemas/ExternalStatusReason1Code"
- Prtry:
- description: |
- Proprietary
- Reason for the status, in a proprietary form.
- $ref: "#/components/schemas/Max35Text"
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/ExternalStatusReason1Code"
+ - description: >
+ Code
+
+ Reason for the status, as published in an external reason
+ code list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Proprietary
+ Reason for the status, in a proprietary form.
+ required:
- Prtry
example:
Cd: AGNT
@@ -5294,20 +5822,23 @@ components:
type: object
properties:
Orgtr:
- description: |-
- Originator
- Party that issues the status.
- $ref: "#/components/schemas/PartyIdentification272"
+ allOf:
+ - $ref: "#/components/schemas/PartyIdentification272"
+ - description: |
+ Originator
+ Party that issues the status.
Rsn:
- description: |-
- Reason
- Specifies the reason for the status report.
- $ref: "#/components/schemas/StatusReason6Choice"
+ allOf:
+ - $ref: "#/components/schemas/StatusReason6Choice"
+ - description: |
+ Reason
+ Specifies the reason for the status report.
AddtlInf:
- description: |-
- AdditionalInformation
- Additional information about the status report.
- $ref: "#/components/schemas/Max105Text"
+ allOf:
+ - $ref: "#/components/schemas/Max105Text"
+ - description: |
+ AdditionalInformation
+ Additional information about the status report.
example:
Orgtr:
Nm: Name
@@ -5333,46 +5864,55 @@ components:
type: object
properties:
Tp:
- description: >
- Type
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Type
- Specifies the type of the information supplied in the regulatory
- reporting details.
- $ref: "#/components/schemas/Max35Text"
+ Specifies the type of the information supplied in the regulatory
+ reporting details.
Dt:
- description: |
- Date
+ allOf:
+ - $ref: "#/components/schemas/ISODate"
+ - description: >
+ Date
+
- Date related to the specified type of regulatory reporting details.
- $ref: "#/components/schemas/ISODate"
+ Date related to the specified type of regulatory reporting
+ details.
Ctry:
- description: >
- Country
+ allOf:
+ - $ref: "#/components/schemas/CountryCode"
+ - description: >
+ Country
- Country related to the specified type of regulatory reporting
- details.
- $ref: "#/components/schemas/CountryCode"
+ Country related to the specified type of regulatory reporting
+ details.
Cd:
- description: >
- Code
-
- Specifies the nature, purpose, and reason for the transaction to be
- reported for regulatory and statutory requirements in a coded form.
- $ref: "#/components/schemas/Max10Text"
+ allOf:
+ - $ref: "#/components/schemas/Max10Text"
+ - description: >
+ Code
+
+ Specifies the nature, purpose, and reason for the transaction to
+ be reported for regulatory and statutory requirements in a coded
+ form.
Amt:
- description: >
- Amount
+ allOf:
+ - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ - description: >
+ Amount
- Amount of money to be reported for regulatory and statutory
- requirements.
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ Amount of money to be reported for regulatory and statutory
+ requirements.
Inf:
description: >
Information
+
Additional details that cater for specific domestic regulatory
requirements.
anyOf:
@@ -5392,27 +5932,29 @@ components:
SupplementaryData1:
title: SupplementaryData1
description: >
- Additional information that can not be captured in the structured fields
+ Additional information that cannot be captured in the structured fields
and/or any other specific block.
type: object
properties:
PlcAndNm:
- description: >
- PlaceAndName
+ allOf:
+ - $ref: "#/components/schemas/Max350Text"
+ - description: >
+ PlaceAndName
- Unambiguous reference to the location where the supplementary data
- must be inserted in the message instance.
- $ref: "#/components/schemas/Max350Text"
+ Unambiguous reference to the location where the supplementary
+ data must be inserted in the message instance.
Envlp:
- description: >
- Envelope
+ allOf:
+ - $ref: "#/components/schemas/SupplementaryDataEnvelope1"
+ - description: >
+ Envelope
- Technical element wrapping the supplementary data.
+ Technical element wrapping the supplementary data.
- Technical component that contains the validated supplementary data
- information. This technical envelope allows to segregate the
- supplementary data information from any other information.
- $ref: "#/components/schemas/SupplementaryDataEnvelope1"
+ Technical component that contains the validated supplementary
+ data information. This technical envelope allows to segregate
+ the supplementary data information from any other information.
required:
- Envlp
example:
@@ -5436,25 +5978,28 @@ components:
type: object
properties:
Rate:
- description: |
- Rate
+ allOf:
+ - $ref: "#/components/schemas/PercentageRate"
+ - description: |
+ Rate
- Rate used to calculate the tax.
- $ref: "#/components/schemas/PercentageRate"
+ Rate used to calculate the tax.
TaxblBaseAmt:
- description: |
- TaxableBaseAmount
+ allOf:
+ - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ - description: |
+ TaxableBaseAmount
- Amount of money on which the tax is based.
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ Amount of money on which the tax is based.
TtlAmt:
- description: >
- TotalAmount
+ allOf:
+ - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ - description: >
+ TotalAmount
- Total amount that is the result of the calculation of the tax for
- the record.
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ Total amount that is the result of the calculation of the tax
+ for the record.
Dtls:
description: >
Details
@@ -5490,19 +6035,21 @@ components:
type: object
properties:
Titl:
- description: >
- Title
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Title
- Title or position of debtor or the debtor's authorised
- representative.
- $ref: "#/components/schemas/Max35Text"
+ Title or position of debtor or the debtor's authorised
+ representative.
Nm:
- description: |
- Name
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: |
+ Name
- Name of the debtor or the debtor's authorised representative.
- $ref: "#/components/schemas/Max140Text"
+ Name of the debtor or the debtor's authorised representative.
example:
Titl: Mr
Nm: John Doe
@@ -5515,71 +6062,85 @@ components:
type: object
properties:
Cdtr:
- description: >
- Creditor
+ allOf:
+ - $ref: "#/components/schemas/TaxParty1"
+ - description: >
+ Creditor
- Party on the credit side of the transaction to which the tax
- applies.
- $ref: "#/components/schemas/TaxParty1"
+ Party on the credit side of the transaction to which the tax
+ applies.
Dbtr:
- description: |
- Debtor
+ allOf:
+ - $ref: "#/components/schemas/TaxParty2"
+ - description: >
+ Debtor
+
- Party on the debit side of the transaction to which the tax applies.
- $ref: "#/components/schemas/TaxParty2"
+ Party on the debit side of the transaction to which the tax
+ applies.
UltmtDbtr:
- description: >
- UltimateDebtor
+ allOf:
+ - $ref: "#/components/schemas/TaxParty2"
+ - description: >
+ UltimateDebtor
- Ultimate party that owes an amount of money to the (ultimate)
- creditor, in this case, to the taxing authority.
- $ref: "#/components/schemas/TaxParty2"
+ Ultimate party that owes an amount of money to the (ultimate)
+ creditor, in this case, to the taxing authority.
AdmstnZone:
- description: |
- AdministrationZone
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ AdministrationZone
- Territorial part of a country to which the tax payment is related.
- $ref: "#/components/schemas/Max35Text"
+
+ Territorial part of a country to which the tax payment is
+ related.
RefNb:
- description: |
- ReferenceNumber
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: |
+ ReferenceNumber
- Tax reference information that is specific to a taxing agency.
- $ref: "#/components/schemas/Max140Text"
+ Tax reference information that is specific to a taxing agency.
Mtd:
- description: >
- Method
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Method
- Method used to indicate the underlying business or how the tax is
- paid.
- $ref: "#/components/schemas/Max35Text"
+ Method used to indicate the underlying business or how the tax
+ is paid.
TtlTaxblBaseAmt:
- description: |
- TotalTaxableBaseAmount
+ allOf:
+ - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ - description: |
+ TotalTaxableBaseAmount
- Total amount of money on which the tax is based.
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ Total amount of money on which the tax is based.
TtlTaxAmt:
- description: |
- TotalTaxAmount
+ allOf:
+ - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ - description: |
+ TotalTaxAmount
- Total amount of money as result of the calculation of the tax.
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ Total amount of money as result of the calculation of the tax.
Dt:
- description: |
- Date
+ allOf:
+ - $ref: "#/components/schemas/ISODate"
+ - description: |
+ Date
- Date by which tax is due.
- $ref: "#/components/schemas/ISODate"
+ Date by which tax is due.
SeqNb:
- description: |
- SequenceNumber
+ allOf:
+ - $ref: "#/components/schemas/Number"
+ - description: |
+ SequenceNumber
- Sequential number of the tax report
- $ref: "#/components/schemas/Number"
+ Sequential number of the tax report.
Rcrd:
description: |
Record
@@ -5626,25 +6187,28 @@ components:
type: object
properties:
TaxId:
- description: |
- TaxIdentification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ TaxIdentification
- Tax identification number of the creditor.
- $ref: "#/components/schemas/Max35Text"
+ Tax identification number of the creditor.
RegnId:
- description: >
- RegistrationIdentification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ RegistrationIdentification
- Unique identification, as assigned by an organisation, to
- unambiguously identify a party.
- $ref: "#/components/schemas/Max35Text"
+ Unique identification, as assigned by an organisation, to
+ unambiguously identify a party.
TaxTp:
- description: |
- TaxType
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ TaxType
- Type of tax payer.
- $ref: "#/components/schemas/Max35Text"
+ Type of tax payer.
example:
TaxId: 123456789
RegnId: 123456789
@@ -5656,31 +6220,35 @@ components:
type: object
properties:
TaxId:
- description: |
- TaxIdentification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ TaxIdentification
- Tax identification number of the debtor.
- $ref: "#/components/schemas/Max35Text"
+ Tax identification number of the debtor.
RegnId:
- description: >
- RegistrationIdentification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ RegistrationIdentification
- Unique identification, as assigned by an organisation, to
- unambiguously identify a party.
- $ref: "#/components/schemas/Max35Text"
+ Unique identification, as assigned by an organisation, to
+ unambiguously identify a party.
TaxTp:
- description: |
- TaxType
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ TaxType
- Type of tax payer.
- $ref: "#/components/schemas/Max35Text"
+ Type of tax payer.
Authstn:
- description: |
- Authorisation
+ allOf:
+ - $ref: "#/components/schemas/TaxAuthorisation1"
+ - description: |
+ Authorisation
- Details of the authorised tax paying party.
- $ref: "#/components/schemas/TaxAuthorisation1"
+ Details of the authorised tax paying party.
example:
TaxId: 123456789
RegnId: 123456789
@@ -5695,25 +6263,28 @@ components:
type: object
properties:
FrToDt:
- $ref: "#/components/schemas/DatePeriod2"
- description: >
- FromToDate
+ allOf:
+ - $ref: "#/components/schemas/DatePeriod2"
+ - description: >
+ FromToDate
- Range of time between a start date and an end date for which the tax
- report is provided.
+ Range of time between a start date and an end date for which the
+ tax report is provided.
Tp:
- $ref: "#/components/schemas/TaxRecordPeriod1Code"
- description: |
- Type
+ allOf:
+ - $ref: "#/components/schemas/TaxRecordPeriod1Code"
+ - description: |
+ Type
- Identification of the period related to the tax payment.
+ Identification of the period related to the tax payment.
Yr:
- $ref: "#/components/schemas/ISOYear"
- description: |
- Year
+ allOf:
+ - $ref: "#/components/schemas/ISOYear"
+ - description: |
+ Year
- Year related to the tax payment.
+ Year related to the tax payment.
example:
Yr: 2020
Tp: MM01
@@ -5727,69 +6298,78 @@ components:
type: object
properties:
AddtlInf:
- $ref: "#/components/schemas/Max140Text"
- description: |
- AdditionalInformation
+ allOf:
+ - $ref: "#/components/schemas/Max140Text"
+ - description: |
+ AdditionalInformation
- Further details of the tax record.
+ Further details of the tax record.
CertId:
- $ref: "#/components/schemas/Max35Text"
- description: >
- CertificateIdentification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ CertificateIdentification
- Identification number of the tax report as assigned by the taxing
- authority.
+ Identification number of the tax report as assigned by the
+ taxing authority.
Ctgy:
- $ref: "#/components/schemas/Max35Text"
- description: |
- Category
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Category
- Specifies the tax code as published by the tax authority.
+ Specifies the tax code as published by the tax authority.
CtgyDtls:
- $ref: "#/components/schemas/Max35Text"
- description: |
- CategoryDetails
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ CategoryDetails
- Provides further details of the category tax code.
+ Provides further details of the category tax code.
DbtrSts:
- $ref: "#/components/schemas/Max35Text"
- description: >
- DebtorStatus
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ DebtorStatus
- Code provided by local authority to identify the status of the party
- that has drawn up the settlement document.
+ Code provided by local authority to identify the status of the
+ party that has drawn up the settlement document.
FrmsCd:
- $ref: "#/components/schemas/Max35Text"
- description: >
- FormsCode
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ FormsCode
- Identifies, in a coded form, on which template the tax report is to
- be provided.
+ Identifies, in a coded form, on which template the tax report is
+ to be provided.
Prd:
- $ref: "#/components/schemas/TaxPeriod3"
- description: >
- Period
+ allOf:
+ - $ref: "#/components/schemas/TaxPeriod3"
+ - description: >
+ Period
- Set of elements used to provide details on the period of time
- related to the tax payment.
+ Set of elements used to provide details on the period of time
+ related to the tax payment.
TaxAmt:
- $ref: "#/components/schemas/TaxAmount3"
- description: >
- TaxAmount
+ allOf:
+ - $ref: "#/components/schemas/TaxAmount3"
+ - description: >
+ TaxAmount
- Set of elements used to provide information on the amount of the tax
- record.
+ Set of elements used to provide information on the amount of the
+ tax record.
Tp:
- $ref: "#/components/schemas/Max35Text"
- description: |
- Type
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: |
+ Type
- High level code to identify the type of tax details.
+ High level code to identify the type of tax details.
example:
Tp: VAT
Ctgy: A
@@ -5798,33 +6378,42 @@ components:
CertId: 123456789
FrmsCd: 123456789
Prd:
- FrstDay: "2019-01-01"
- LastDay: "2019-12-31"
+ Yr: 2019
+ Tp: MM01
+ FrToDt:
+ FrDt: "2019-01-01"
+ ToDt: "2019-12-31"
TaxAmt:
Rate: 0.2
- TaxblBaseAmt: 1000
- TtlAmt: 200
+ TaxblBaseAmt:
+ Ccy: EUR
+ Amt: 1000
+ TtlAmt:
+ Ccy: EUR
+ Amt: 200
AddtlInf: VAT applicable
TaxRecordDetails3:
title: TaxRecordDetails3
description: |
- Details on the tax period and amount
+ Details on the tax period and amount.
type: object
properties:
Prd:
- description: >
- Period
+ allOf:
+ - $ref: "#/components/schemas/TaxPeriod3"
+ - description: >
+ Period
- Set of elements used to provide details on the period of time
- related to the tax payment.
- $ref: "#/components/schemas/TaxPeriod3"
+ Set of elements used to provide details on the period of time
+ related to the tax payment.
Amt:
- description: |
- Amount
+ allOf:
+ - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ - description: |
+ Amount
- Underlying tax amount related to the specified period.
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
+ Underlying tax amount related to the specified period.
required:
- Amt
example:
@@ -5884,9 +6473,18 @@ components:
TermsRequest_FIToFICustomerCreditProposal:
title: TermsRequest_FIToFICustomerCreditProposal
type: object
+ description: >
+ This message is sent by a financial institution to a financial
+ institution to propose the terms of a credit to a customer.
properties:
GrpHdr:
- $ref: "#/components/schemas/GroupHeader129"
+ allOf:
+ - $ref: "#/components/schemas/GroupHeader129"
+ - description: >
+ Group Header
+
+ Set of characteristics shared by all individual transactions
+ included in the message.
required:
- GrpHdr
example:
@@ -5910,11 +6508,27 @@ components:
TermsResponse_FIToFICustomerCreditConfirmation:
title: TermsResponse_FIToFICustomerCreditConfirmation
type: object
+ description: >
+ This message is sent by the initiating party to the executing party,
+ directly or through one or more intermediaries, to confirm the credit
+ transfer transaction.
properties:
GrpHdr:
- $ref: "#/components/schemas/GroupHeader129"
+ allOf:
+ - $ref: "#/components/schemas/GroupHeader129"
+ - description: >
+ Group Header
+
+ Set of characteristics shared by all individual transactions
+ included in the message.
CdtTrfTxInf:
- $ref: "#/components/schemas/CreditTransferTransaction67"
+ allOf:
+ - $ref: "#/components/schemas/CreditTransferTransaction67"
+ - description: >
+ Credit Transfer Transaction Information
+
+ Set of elements providing information specific to the individual
+ credit transfer(s).
required:
- GrpHdr
- CdtTrfTxInf
@@ -5944,69 +6558,86 @@ components:
VerificationReason1Choice:
title: VerificationReason1Choice
type: object
- properties:
- Cd:
- description: >
- Code
-
- Reason why the verified identification information is incorrect, as
- published in an external reason code list.
- $ref: "#/components/schemas/ExternalVerificationReason1Code"
- Prtry:
- description: >
- Proprietary
-
- Reason why the verified identification information is incorrect, in
- a free text form.
- $ref: "#/components/schemas/Max35Text"
+ description: |
+ Choice of format for the verification reason.
+ Only one, between the coded and the proprietary, can be chosen.
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: "#/components/schemas/ExternalVerificationReason1Code"
+ - description: >
+ Code
+
+ Reason why the verified identification information is
+ incorrect, as published in an external reason code list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ Proprietary
+
+ Reason why the verified identification information is
+ incorrect, in a free text form.
+ required:
- Prtry
example:
Cd: AGNT
VerificationReport4:
title: VerificationReport4
type: object
+ description: >-
+ VerificationReport
+
+ Provides information about the verification of party and/or account
+ identification information.
properties:
OrgnlId:
- description: >
- OriginalIdentification
+ allOf:
+ - $ref: "#/components/schemas/Max35Text"
+ - description: >
+ OriginalIdentification
- Unique identification, as assigned by a sending party, to
- unambiguously identify the party and account identification
- information group within the original message.
- $ref: "#/components/schemas/Max35Text"
+ Unique identification, as assigned by a sending party, to
+ unambiguously identify the party and account identification
+ information group within the original message.
Vrfctn:
- description: >
- Verification
+ allOf:
+ - $ref: "#/components/schemas/IdentificationVerificationIndicator"
+ - description: >
+ Verification
- Identifies whether the party and/or account information received is
- correct. Boolean value.
- $ref: "#/components/schemas/IdentificationVerificationIndicator"
+ Identifies whether the party and/or account information received
+ is correct. Boolean value.
Rsn:
- description: >
- Reason.
+ allOf:
+ - $ref: "#/components/schemas/VerificationReason1Choice"
+ - description: >
+ Reason
- Specifies the reason why the verified identification information is
- incorrect.
- $ref: "#/components/schemas/VerificationReason1Choice"
+ Specifies the reason why the verified identification information
+ is incorrect.
OrgnlPtyAndAcctId:
- description: >
- OriginalPartyAndAccountIdentification
+ allOf:
+ - $ref: "#/components/schemas/IdentificationInformation4"
+ - description: >
+ OriginalPartyAndAccountIdentification
- Provides party and/or account identification information as given in
- the original message.
- $ref: "#/components/schemas/IdentificationInformation4"
+ Provides party and/or account identification information as
+ given in the original message.
UpdtdPtyAndAcctId:
- description: |
- UpdatedPartyAndAccountIdentification
- Provides party and/or account identification information.
- $ref: "#/components/schemas/IdentificationInformation4"
+ allOf:
+ - $ref: "#/components/schemas/IdentificationInformation4"
+ - description: |
+ UpdatedPartyAndAccountIdentification
+ Provides party and/or account identification information.
required:
- OrgnlId
- Vrfctn
+ - UpdtdPtyAndAcctId
example:
OrgnlId: 1.2345678901234568e+33
Vrfctn: true
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml
index 49b509d1..13864be7 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml
@@ -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
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml
index 1818f243..b2f05186 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml
@@ -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
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml
index cc219a7c..44238a56 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml
@@ -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
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml
index e5b339cd..358945d2 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml
@@ -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
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml
index e7214e3c..64ee1c87 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml
@@ -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
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml
index bca1f4b9..c0692c54 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml
@@ -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
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml
index 4c5bf5d1..e26514c9 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml
@@ -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:
@@ -38,4 +40,4 @@ example:
TwnNm: Town name
CtrySubDvsn: Country subdivision
Ctry: Country
- AdrLine: Address line
+ AdrLine: Address line
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml
index cf0fc7b3..dd627b5c 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml
@@ -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:
@@ -35,4 +37,4 @@ example:
TwnNm: Town name
CtrySubDvsn: Country subdivision
Ctry: Country
- AdrLine: Address line
+ AdrLine: Address line
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml
index f321f273..bc7c879c 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml
@@ -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
@@ -41,4 +45,4 @@ example:
TwnNm: Town name
CtrySubDvsn: Country subdivision
Ctry: Country
- AdrLine: Address line
+ AdrLine: Address line
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml
index 18f9a207..9c8e58f4 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml
@@ -5,29 +5,33 @@ description: >
type: object
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: >
- LEI
+ allOf:
+ - $ref: ./LEIIdentifier.yaml
+ - description: >
+ LEI
- 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: >
- PostalAddress
+ allOf:
+ - $ref: ./PostalAddress27.yaml
+ - description: >
+ PostalAddress
- Information that locates and identifies a specific address, as defined by postal services.
- $ref: ./PostalAddress27.yaml
+ Information that locates and identifies a specific address, as defined by postal services.
example:
Id: 123
LEI: 123
@@ -37,9 +41,4 @@ example:
Dept: Department
SubDept: Sub department
StrtNm: Street name
- BldgNb: Building number
- PstCd: Post code
- TwnNm: Town name
- CtrySubDvsn: Country subdivision
- Ctry: Country
- AdrLine: Address line
+ BldgNb: Building number
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml
index 6b70744b..d26cc9bf 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml
@@ -4,44 +4,49 @@ description: |
Provides the details to identify an account.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: ./AccountIdentification4Choice.yaml
+ - description: >
+ Identification
- Unique and unambiguous identification for the account between the account owner and the
- account servicer.
- $ref: ./AccountIdentification4Choice.yaml
+ Unique and unambiguous identification for the account between the account owner and the
+ account servicer.
Tp:
- description: >
- Type
+ allOf:
+ - $ref: ./CashAccountType2Choice.yaml
+ - description: >
+ Type
- Specifies the nature, or use of the account.
- $ref: ./CashAccountType2Choice.yaml
+ Specifies the nature, or use of the account.
Ccy:
- description: >
- Currency
+ allOf:
+ - $ref: ./ActiveOrHistoricCurrencyCode.yaml
+ - description: >
+ Currency
- Definition: Identification of the currency in which the account is held.
+ Identification of the currency in which the account is held.
- Usage: Currency should only be used in case one and the same account number covers several
- currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
- $ref: ./ActiveOrHistoricCurrencyCode.yaml
+ Usage: Currency should only be used in case one and the same account number covers several
+ currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
Nm:
- description: >
- Name
+ allOf:
+ - $ref: ./Max70Text.yaml
+ - description: >
+ Name
- Definition: Name of the account, as assigned by the account servicing institution, in agreement with the
- account owner in order to provide an additional means of identification of the account.
+ Name of the account, as assigned by the account servicing institution, in agreement with the
+ account owner in order to provide an additional means of identification of the account.
- Usage: The account name is different from the account owner name. The account name is used in
- certain user communities to provide a means of identifying the account, in addition to the account
- owner's identity and the account number.
- $ref: ./Max70Text.yaml
+ Usage: The account name is different from the account owner name. The account name is used in
+ certain user communities to provide a means of identifying the account, in addition to the account
+ owner's identity and the account number.
Prxy:
- description: >
- Proxy
+ allOf:
+ - $ref: ./ProxyAccountIdentification1.yaml
+ - description: >
+ Proxy
- Specifies an alternate assumed name for the identification of the account.
- $ref: ./ProxyAccountIdentification1.yaml
+ Specifies an alternate assumed name for the identification of the account.
example:
Id:
IBAN: BE71096123456769
@@ -50,4 +55,4 @@ example:
Ccy: EUR
Nm: My account
Prxy:
- Id: 12345
+ Id: 12345
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml
index b8bbb20d..9e4f9f9a 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml
@@ -2,23 +2,26 @@ title: CashAccountType2Choice
description: |
Specifies the nature, or use of the account.
type: object
-properties:
- Cd:
- description: >
- Code
-
- Account type, in a coded form.
- $ref: ./ExternalCashAccountType1Code.yaml
- Prtry:
- description: >
- Proprietary
-
- Nature or use of the account in a proprietary form.
- $ref: ./Max35Text.yaml
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalCashAccountType1Code.yaml
+ - description: >
+ Code
+
+ Account type, in a coded form.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Proprietary
+
+ Nature or use of the account in a proprietary form.
+ required:
- Prtry
example:
- Cd: CACC
+ Cd: CACC
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml
index 6f42093c..43eadae2 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml
@@ -3,23 +3,26 @@ description: >
Contains details about high level purpose of the mandate based on a set of
pre-defined categories.
type: object
-properties:
- Cd:
- description: >
- Code
-
- Category purpose, as published in an external category purpose code list.
- $ref: ./ExternalCategoryPurpose1Code.yaml
- Prtry:
- description: >
- Proprietary
-
- Category purpose, in a proprietary form.
- $ref: ./Max35Text.yaml
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalCategoryPurpose1Code.yaml
+ - description: >
+ Code
+
+ Category purpose, as published in an external category purpose code list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Proprietary
+
+ Category purpose, in a proprietary form.
+ required:
- Prtry
example:
- Cd: CASH
+ Cd: CASH
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml
index f7e9ca1c..8fae7971 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml
@@ -1,19 +1,16 @@
title: ChargeBearerType1Code
-description: >
+description: |
Specifies which party(ies) will pay charges due for processing of the
instruction.
- DEBT BorneByDebtor All transaction charges are to be borne by the debtor.
-
- CRED BorneByCreditor All transaction charges are to be borne by the creditor.
-
- SHAR Shared In a credit transfer context, means that transaction charges on
- the sender side are to be borne by the debtor, transaction charges on the receiver side are to
- be borne by the creditor. In a direct debit context, means that transaction charges on the sender side
- are to be borne by the creditor, transaction charges on the receiver
-
- SLEV FollowingServiceLevel Charges are to be applied following the rules
- agreed in the service level.
+ DEBT: BorneByDebtor All transaction charges are to be borne by the debtor.
+ CRED: BorneByCreditor All transaction charges are to be borne by the creditor.
+ SHAR: Shared In a credit transfer context, means that transaction charges on
+ the sender side are to be borne by the debtor, transaction charges on the receiver side are to
+ be borne by the creditor. In a direct debit context, means that transaction charges on the sender side
+ are to be borne by the creditor, transaction charges on the receiver
+ SLEV : FollowingServiceLevel Charges are to be applied following the rules
+ agreed in the service level.
type: string
enum:
- DEBT
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml
index 626528eb..4fd12f57 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml
@@ -4,23 +4,26 @@ description: >
Specifies the type of charge.
type: object
-properties:
- Cd:
- description: >
- Code
-
- Charge type, in a coded form.
- $ref: ./ExternalChargeType1Code.yaml
- Prtry:
- description: >
- Proprietary
-
- Type of charge in a proprietary form, as defined by the issuer.
- $ref: ./GenericIdentification3.yaml
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalChargeType1Code.yaml
+ - description: >
+ Code
+
+ Charge type, in a coded form.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: ./GenericIdentification3.yaml
+ - description: >
+ Proprietary
+
+ Type of charge in a proprietary form, as defined by the issuer.
+ required:
- Prtry
example:
- Cd: CASH
+ Cd: CASH
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml
index 5832f88b..ead009a1 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml
@@ -6,23 +6,26 @@ description: |
type: object
properties:
Amt:
- description: >
- Amount
+ allOf:
+ - $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ - description: >
+ Amount
- Transaction charges to be paid by the charge bearer.
- $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ Transaction charges to be paid by the charge bearer.
Agt:
- description: >
- Agent
+ allOf:
+ - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ - description: >
+ Agent
- Agent that takes the transaction charges or to which the transaction charges are due.
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ Agent that takes the transaction charges or to which the transaction charges are due.
Tp:
- description: >
- Type
+ allOf:
+ - $ref: ./ChargeType3Choice.yaml
+ - description: >
+ Type
- Defines the type of charges.
- $ref: ./ChargeType3Choice.yaml
+ Defines the type of charges.
required:
- Amt
- Agt
@@ -36,4 +39,4 @@ example:
FinInstnId:
BICFI: BICFI
Tp:
- Cd: SHAR
+ Cd: SHAR
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml
index 1f7115ff..22d59f41 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml
@@ -1,18 +1,12 @@
title: ClearingChannel2Code
-description: >
+description: |
Specifies the clearing channel for the routing of the transaction, as part of
the payment type identification.
- RTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross
- settlement system.
-
- RTNS RealTimeNetSettlementSystem Clearing channel is a real-time net
- settlement system.
-
- MPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement
- system.
-
- BOOK BookTransfer Payment through internal book transfer.
+ RTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.
+ RTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.
+ MPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.
+ BOOK: BookTransfer Payment through internal book transfer.
type: string
enum:
- RTGS
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml
index 20692ad6..4f7097d4 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml
@@ -1,25 +1,27 @@
title: ClearingSystemIdentification2Choice
description: |
- Choice of a clearing system identifier.
+ Specifies the clearing system identification.
type: object
-properties:
- Cd:
- description: >
- Code
-
- Identification of a member of a clearing system
- $ref: ./ExternalClearingSystemIdentification1Code.yaml
- Prtry:
- description: >
- Proprietary
-
- Identification code for a clearing system, that has not yet been identified in the list of clearing
- systems.
- $ref: ./Max35Text.yaml
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalClearingSystemIdentification1Code.yaml
+ - description: >
+ Code
+
+ Clearing system identification code, as published in an external list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Proprietary
+
+ Proprietary identification of the clearing system.
+ required:
- Prtry
example:
- Cd: CHQB
+ Cd: CHIPS
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml
index 108faebc..7bc8e742 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml
@@ -5,21 +5,23 @@ description: >
type: object
properties:
ClrSysId:
- description: >
- ClearingSystemIdentification.
+ allOf:
+ - $ref: ./ClearingSystemIdentification2Choice.yaml
+ - description: >
+ ClearingSystemIdentification
- Specification of a pre-agreed offering between clearing agents or the channel through which
- the payment instruction is processed.
- $ref: ./ClearingSystemIdentification2Choice.yaml
+ Specification of a pre-agreed offering between clearing agents or the channel through which
+ the payment instruction is processed.
MmbId:
- description: >
- MemberIdentification.
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ MemberIdentification
- Identification of a member of a clearing system.
- $ref: ./Max35Text.yaml
+ Identification of a member of a clearing system.
required:
- MmbId
example:
ClrSysId:
Cd: CHQB
- MmbId: 123456789
+ MmbId: 123456789
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml
index 7f13b67f..9d0a69a5 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml
@@ -4,84 +4,97 @@ description: |
type: object
properties:
NmPrfx:
- description: >
- NamePrefix
+ allOf:
+ - $ref: ./NamePrefix2Code.yaml
+ - description: >
+ NamePrefix
- Specifies the terms used to formally address a person.
- $ref: ./NamePrefix2Code.yaml
+ Specifies the terms used to formally address a person.
Nm:
- description: >
- Name
+ allOf:
+ - $ref: ./Max140Text.yaml
+ - description: >
+ Name
- Name by which a party is known and which is usually used to identify that party.
- $ref: ./Max140Text.yaml
+ Name by which a party is known and which is usually used to identify that party.
PhneNb:
- description: >
- PhoneNumber
+ allOf:
+ - $ref: ./PhoneNumber.yaml
+ - description: >
+ PhoneNumber
- Collection of information that identifies a phone number, as defined by telecom services.
- $ref: ./PhoneNumber.yaml
+ Collection of information that identifies a phone number, as defined by telecom services.
MobNb:
- description: >
- MobilePhoneNumber
+ allOf:
+ - $ref: ./PhoneNumber.yaml
+ - description: >
+ MobilePhoneNumber
- Collection of information that identifies a mobile phone number, as defined by telecom services.
- $ref: ./PhoneNumber.yaml
+ Collection of information that identifies a mobile phone number, as defined by telecom services.
FaxNb:
- description: >
- FaxNumber
+ allOf:
+ - $ref: ./PhoneNumber.yaml
+ - description: >
+ FaxNumber
- Collection of information that identifies a fax number, as defined by telecom services.
- $ref: ./PhoneNumber.yaml
+ Collection of information that identifies a fax number, as defined by telecom services.
URLAdr:
- description: >
- URLAddress
+ allOf:
+ - $ref: ./Max2048Text.yaml
+ - description: >
+ URLAddress
- Address for the Universal Resource Locator (URL), for example an address used over the
- www (HTTP) service.
- $ref: ./Max2048Text.yaml
+ Address for the Universal Resource Locator (URL), for example an address used over the
+ www (HTTP) service.
EmailAdr:
- description: >
- EmailAddress
+ allOf:
+ - $ref: ./Max256Text.yaml
+ - description: >
+ EmailAddress
- Address for electronic mail (e-mail).
- $ref: ./Max256Text.yaml
+ Address for electronic mail (e-mail).
EmailPurp:
- description: >
- EmailPurpose
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ EmailPurpose
- Purpose for which an email address may be used.
- $ref: ./Max35Text.yaml
+ Purpose for which an email address may be used.
JobTitl:
- description: >
- JobTitle
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ JobTitle
- Title of the function.
- $ref: ./Max35Text.yaml
+ Title of the function.
Rspnsblty:
- description: >
- Responsibility
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Responsibility
- Role of a person in an organisation.
- $ref: ./Max35Text.yaml
+ Role of a person in an organisation.
Dept:
- description: >
- Department
+ allOf:
+ - $ref: ./Max70Text.yaml
+ - description: >
+ Department
- Identification of a division of a large organisation or building.
- $ref: ./Max70Text.yaml
+ Identification of a division of a large organisation or building.
Othr:
- description: >
- OtherContact
+ allOf:
+ - $ref: ./OtherContact1.yaml
+ - description: >
+ OtherContact
- Contact details in another form.
- $ref: ./OtherContact1.yaml
+ Contact details in another form.
PrefrdMtd:
- description: >
- PreferredContactMethod
+ allOf:
+ - $ref: ./PreferredContactMethod2Code.yaml
+ - description: >
+ PreferredContactMethod
- Preferred method used to reach the contact.
- $ref: ./PreferredContactMethod2Code.yaml
+ Preferred method used to reach the contact.
example:
NmPrfx: Mr
Nm: John Doe
@@ -89,4 +102,4 @@ example:
MobNb: +123-123-321
FaxNb: +123-123-321
URLAdr: http://www.example.com
- EmailAdr: example@example.com
+ EmailAdr: example@example.com
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml
index e7815526..9fa73ac7 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml
@@ -4,81 +4,93 @@ description: |
type: object
properties:
NmPrfx:
- description: >
- NamePrefix
+ allOf:
+ - $ref: ./NamePrefix2Code.yaml
+ - description: >
+ NamePrefix
- Name prefix to be used before the name of the person.
- $ref: ./NamePrefix2Code.yaml
+ Name prefix to be used before the name of the person.
Nm:
- description: >
- Name
+ allOf:
+ - $ref: ./Max140Text.yaml
+ - description: >
+ Name
- Name by which a party is known and which is usually used to identify that party.
- $ref: ./Max140Text.yaml
+ Name by which a party is known and which is usually used to identify that party.
PhneNb:
- description: >
- PhoneNumber
+ allOf:
+ - $ref: ./PhoneNumber.yaml
+ - description: >
+ PhoneNumber
- Collection of information that identifies a phone number, as defined by telecom services.
- $ref: ./PhoneNumber.yaml
+ Collection of information that identifies a phone number, as defined by telecom services.
MobNb:
- description: >
- MobilePhoneNumber
+ allOf:
+ - $ref: ./PhoneNumber.yaml
+ - description: >
+ MobilePhoneNumber
- Collection of information that identifies a mobile phone number, as defined by telecom services.
- $ref: ./PhoneNumber.yaml
+ Collection of information that identifies a mobile phone number, as defined by telecom services.
FaxNb:
- description: >
- FaxNumber
+ allOf:
+ - $ref: ./PhoneNumber.yaml
+ - description: >
+ FaxNumber
- Collection of information that identifies a fax number, as defined by telecom services.
- $ref: ./PhoneNumber.yaml
+ Collection of information that identifies a fax number, as defined by telecom services.
EmailAdr:
- description: >
- EmailAddress
+ allOf:
+ - $ref: ./Max2048Text.yaml
+ - description: >
+ EmailAddress
- Address for electronic mail (e-mail).
- $ref: ./Max2048Text.yaml
+ Address for electronic mail (e-mail).
EmailPurp:
- description: >
- EmailPurpose
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ EmailPurpose
- Purpose for which an email address may be used.
- $ref: ./Max35Text.yaml
+ Purpose for which an email address may be used.
JobTitl:
- description: >
- JobTitle
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ JobTitle
- Title of the function.
- $ref: ./Max35Text.yaml
+ Title of the function.
Rspnsblty:
- description: >
- Responsibility
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Responsibility
- Role of a person in an organisation.
- $ref: ./Max35Text.yaml
+ Role of a person in an organisation.
Dept:
- description: >
- Department
+ allOf:
+ - $ref: ./Max70Text.yaml
+ - description: >
+ Department
- Identification of a division of a large organisation or building.
- $ref: ./Max70Text.yaml
+ Identification of a division of a large organisation or building.
Othr:
- description: >
- Other
+ allOf:
+ - $ref: ./OtherContact1.yaml
+ - description: >
+ Other
- : Contact details in another form.
- $ref: ./OtherContact1.yaml
+ Contact details in another form.
PrefrdMtd:
- description: >
- PreferredMethod
+ allOf:
+ - $ref: ./PreferredContactMethod1Code.yaml
+ - description: >
+ PreferredMethod
- Preferred method used to reach the contact.
- $ref: ./PreferredContactMethod1Code.yaml
+ Preferred method used to reach the contact.
example:
NmPrfx: Mr
Nm: John Doe
PhneNb: +123-123-321
MobNb: +123-123-321
FaxNb: +123-123-321
- EmailAdr: example@example.com
+ EmailAdr: example@example.com
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml
index b49ca021..ee8fbca0 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml
@@ -5,119 +5,131 @@ description: >
type: object
properties:
PmtId:
- description: >
- PaymentIdentification
+ allOf:
+ - $ref: ./PaymentIdentification13.yaml
+ - description: >
+ PaymentIdentification
- Set of elements used to reference a payment instruction.
- $ref: ./PaymentIdentification13.yaml
+ Set of elements used to reference a payment instruction.
PmtTpInf:
- description: >
- PaymentTypeInformation
+ allOf:
+ - $ref: ./PaymentTypeInformation28.yaml
+ - description: >
+ PaymentTypeInformation
- Set of elements used to further specify the type of transaction.
- $ref: ./PaymentTypeInformation28.yaml
+ Set of elements used to further specify the type of transaction.
IntrBkSttlmAmt:
- description: >
- InterbankSettlementAmount
+ allOf:
+ - $ref: ./ActiveCurrencyAndAmount.yaml
+ - description: >
+ InterbankSettlementAmount
- Amount of money moved between the instructing agent and the instructed agent.
- $ref: ./ActiveCurrencyAndAmount.yaml
+ Amount of money moved between the instructing agent and the instructed agent.
InstdAmt:
- description: >
- InstructedAmount
+ allOf:
+ - $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ - description: >
+ InstructedAmount
- 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.
- $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ 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.
XchgRate:
- description: >
- ExchangeRate
+ allOf:
+ - $ref: ./BaseOneRate.yaml
+ - description: >
+ ExchangeRate
- Factor used to convert an amount from one currency into another. This reflects the price at
- which one currency was bought with another currency.
- $ref: ./BaseOneRate.yaml
+ Factor used to convert an amount from one currency into another. This reflects the price at
+ which one currency was bought with another currency.
ChrgBr:
- description: >
- ChargeBearer
-
- Specifies which party/parties will bear the charges associated with the processing of the
- payment transaction.
$ref: ./ChargeBearerType1Code.yaml
ChrgsInf:
- description: >
- ChargesInformation
+ allOf:
+ - $ref: ./Charges16.yaml
+ - description: >
+ ChargesInformation
- Provides information on the charges to be paid by the charge bearer(s) related to the
- payment transaction
- $ref: ./Charges16.yaml
+ Provides information on the charges to be paid by the charge bearer(s) related to the
+ payment transaction.
Dbtr:
- description: >
- Debtor
+ allOf:
+ - $ref: ./PartyIdentification272.yaml
+ - description: >
+ Debtor
- Party that owes an amount of money to the (ultimate) creditor.
- $ref: ./PartyIdentification272.yaml
+ Party that owes an amount of money to the (ultimate) creditor.
DbtrAcct:
- description: >
- DebtorAccount
+ allOf:
+ - $ref: ./CashAccount40.yaml
+ - description: >
+ DebtorAccount
- Unambiguous identification of the account of the debtor to which a debit entry will be made
- as a result of the transaction.
- $ref: ./CashAccount40.yaml
+ Unambiguous identification of the account of the debtor to which a debit entry will be made
+ as a result of the transaction.
DbtrAgt:
- description: >
- DebtorAgent
+ allOf:
+ - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ - description: >
+ DebtorAgent
- Financial institution servicing an account for the debtor.
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ Financial institution servicing an account for the debtor.
CdtrAgt:
- description: >
- CreditorAgent
+ allOf:
+ - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ - description: >
+ CreditorAgent
- Financial institution servicing an account for the creditor.
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ Financial institution servicing an account for the creditor.
Cdtr:
- description: >
- Creditor
+ allOf:
+ - $ref: ./PartyIdentification272.yaml
+ - description: >
+ Creditor
- Party to which an amount of money is due.
- $ref: ./PartyIdentification272.yaml
+ Party to which an amount of money is due.
CdtrAcct:
- description: >
- CreditorAccount
+ allOf:
+ - $ref: ./CashAccount40.yaml
+ - description: >
+ CreditorAccount
- Unambiguous identification of the account of the creditor to which a credit entry will be
- posted as a result of the payment transaction.
- $ref: ./CashAccount40.yaml
+ Unambiguous identification of the account of the creditor to which a credit entry will be
+ posted as a result of the payment transaction.
InstrForCdtrAgt:
- description: >
- InstructionForCreditorAgent
+ allOf:
+ - $ref: ./InstructionForCreditorAgent3.yaml
+ - description: >
+ InstructionForCreditorAgent
- Set of elements used to provide information on the remittance advice.
- $ref: ./InstructionForCreditorAgent3.yaml
+ Set of elements used to provide information on the remittance advice.
InstrForNxtAgt:
- description: >
- InstructionForNextAgent
+ allOf:
+ - $ref: ./InstructionForNextAgent1.yaml
+ - description: >
+ InstructionForNextAgent
- Set of elements used to provide information on the remittance advice.
- $ref: ./InstructionForNextAgent1.yaml
+ Set of elements used to provide information on the remittance advice.
Purp:
- description: >
- Purpose
+ allOf:
+ - $ref: ./Purpose2Choice.yaml
+ - description: >
+ Purpose
- Underlying reason for the payment transaction.
- $ref: ./Purpose2Choice.yaml
+ Underlying reason for the payment transaction.
RgltryRptg:
- description: >
- RegulatoryReporting
+ allOf:
+ - $ref: ./RegulatoryReporting3.yaml
+ - description: >
+ RegulatoryReporting
- Information needed due to regulatory and statutory requirements.
- $ref: ./RegulatoryReporting3.yaml
+ Information needed due to regulatory and statutory requirements.
Tax:
- description: >
- Tax
+ allOf:
+ - $ref: ./TaxData1.yaml
+ - description: >
+ Tax
- Provides details on the tax.
- $ref: ./TaxData1.yaml
+ Provides details on the tax.
VrfctnOfTerms:
$ref: ./CryptographicLockChoice.yaml
required:
@@ -200,4 +212,4 @@ example:
Dbtr: TRUE
Cdtr: TRUE
Tax:
- Cdtr
+ Cdtr
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml
index 6a4064a7..be5119b5 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml
@@ -5,77 +5,89 @@ description: >
type: object
properties:
PmtId:
- description: >
- PaymentIdentification
+ allOf:
+ - $ref: ./PaymentIdentification13.yaml
+ - description: >
+ PaymentIdentification
- Set of elements used to reference a payment instruction.
- $ref: ./PaymentIdentification13.yaml
+ Set of elements used to reference a payment instruction.
PmtTpInf:
- description: >
- PaymentTypeInformation
-
- Set of elements used to further specify the type of transaction.
- $ref: ./PaymentTypeInformation28.yaml
+ allOf:
+ - $ref: ./PaymentTypeInformation28.yaml
+ - description: >
+ PaymentTypeInformation
+
+ Set of elements used to further specify the type of transaction.
IntrBkSttlmAmt:
- description: >
- InterbankSettlementAmount
+ allOf:
+ - $ref: ./ActiveCurrencyAndAmount.yaml
+ - description: >
+ InterbankSettlementAmount
- Amount of money moved between the instructing agent and the instructed agent.
- $ref: ./ActiveCurrencyAndAmount.yaml
+ Amount of money moved between the instructing agent and the instructed agent.
Dbtr:
- description: >
- Debtor
+ allOf:
+ - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ - description: >
+ Debtor
- Party that owes an amount of money to the (ultimate) creditor.
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ Party that owes an amount of money to the (ultimate) creditor.
DbtrAcct:
- description: >
- DebtorAccount
+ allOf:
+ - $ref: ./CashAccount40.yaml
+ - description: >
+ DebtorAccount
- Account used to process a payment.
- $ref: ./CashAccount40.yaml
+ Account used to process a payment.
DbtrAgt:
- description: >
- DebtorAgent
+ allOf:
+ - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ - description: >
+ DebtorAgent
- Financial institution servicing an account for the debtor.
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ Financial institution servicing an account for the debtor.
CdtrAgt:
- description: >
- CreditorAgent
+ allOf:
+ - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ - description: >
+ CreditorAgent
- Financial institution servicing an account for the creditor.
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ Financial institution servicing an account for the creditor.
Cdtr:
- description: >
- Creditor
+ allOf:
+ - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ - description: >
+ Creditor
- Party to which an amount of money is due.
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+ Party to which an amount of money is due.
CdtrAcct:
- description: >
- CreditorAccount
+ allOf:
+ - $ref: ./CashAccount40.yaml
+ - description: >
+ CreditorAccount
- Account to which a credit entry is made.
- $ref: ./CashAccount40.yaml
+ Account to which a credit entry is made.
InstrForCdtrAgt:
- description: >
- InstructionForCreditorAgent
+ allOf:
+ - $ref: ./InstructionForCreditorAgent3.yaml
+ - description: >
+ InstructionForCreditorAgent
- Set of elements used to provide information on the remittance advice.
- $ref: ./InstructionForCreditorAgent3.yaml
+ Set of elements used to provide information on the remittance advice.
Purp:
- description: >
- Purpose
+ allOf:
+ - $ref: ./Purpose2Choice.yaml
+ - description: >
+ Purpose
- Underlying reason for the payment transaction.
- $ref: ./Purpose2Choice.yaml
+ Underlying reason for the payment transaction.
VrfctnOfTerms:
- description: >
- VerificationOfTerms
+ allOf:
+ - $ref: ./CryptographicLockChoice.yaml
+ - description: >
+ VerificationOfTerms
- Set of elements used to provide information on the underlying terms of the transaction.
- $ref: ./CryptographicLockChoice.yaml
+ Set of elements used to provide information on the underlying terms of the transaction.
required:
- PmtId
- IntrBkSttlmAmt
@@ -114,4 +126,4 @@ example:
Cd: CHAR
VrfctnOfTerms:
Cntt: CONTENT
- CnttTp: PROPRIETARY
+ CnttTp: PROPRIETARY
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml
index 87723d24..e1718d1e 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml
@@ -1,16 +1,23 @@
title: CryptographicLockChoice
description: |
- NOTE: Unsure on description.
+ Cryptographically signed terms
type: object
-properties:
- IlpV4PrepPacket:
- $ref: ./hexBinary.yaml
- Sh256Sgntr:
- $ref: ./Exact32HexBinaryText.yaml
oneOf:
- - required:
+ - properties:
+ IlpV4PrepPacket:
+ allOf:
+ - $ref: ./hexBinary.yaml
+ - description: >
+ Interledger Protocol packet (ILPv4) containing Cryptographically signed terms
+ required:
- IlpV4PrepPacket
- - required:
+ - properties:
+ Sh256Sgntr:
+ allOf:
+ - $ref: ./Exact32HexBinaryText.yaml
+ - description: >
+ SHA-256 signature of the terms
+ required:
- Sh256Sgntr
example:
- IlpV4PrepPacket: 1234567890ABCDEF
+ IlpV4PrepPacket: 1234567890ABCDEF
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml
index e2e7db8c..41840a66 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml
@@ -4,29 +4,33 @@ description: |
type: object
properties:
BirthDt:
- description: >
- BirthDate
+ allOf:
+ - $ref: ./ISODate.yaml
+ - description: >
+ BirthDate
- Date on which a person is born.
- $ref: ./ISODate.yaml
+ Date on which a person was born.
PrvcOfBirth:
- description: >
- ProvinceOfBirth
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ ProvinceOfBirth
- Province where a person was born.
- $ref: ./Max35Text.yaml
+ Province where a person was born.
CityOfBirth:
- description: >
- CityOfBirth
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ CityOfBirth
- City where a person was born.
- $ref: ./Max35Text.yaml
+ City where a person was born.
CtryOfBirth:
- description: >
- CountryOfBirth
+ allOf:
+ - $ref: ./CountryCode.yaml
+ - description: >
+ CountryOfBirth
- Country where a person was born.
- $ref: ./CountryCode.yaml
+ Country where a person was born.
required:
- BirthDt
- CityOfBirth
@@ -35,4 +39,4 @@ example:
BirthDt: 1970-01-01
PrvcOfBirth: ON
CityOfBirth: Ottawa
- CtryOfBirth: CA
+ CtryOfBirth: CA
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml
index ed3c289d..fd66890b 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml
@@ -4,20 +4,22 @@ description: |
type: object
properties:
FrDt:
- description: >
- FromDate
+ allOf:
+ - $ref: ./ISODate.yaml
+ - description: >
+ FromDate
- Start date of the range.
- $ref: ./ISODate.yaml
+ Start date of the range.
ToDt:
- description: >
- ToDate
+ allOf:
+ - $ref: ./ISODate.yaml
+ - description: >
+ ToDate
- End date of the range.
- $ref: ./ISODate.yaml
+ End date of the range.
required:
- FrDt
- ToDt
example:
- FrDt: '2022-01-01T00:00:00.000Z'
- ToDt: '2022-12-31T23:59:59.999Z'
+ FrDt: '2022-01-01'
+ ToDt: '2022-12-31'
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml
index 4fe4cbf2..eeb5cc83 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml
@@ -2,13 +2,19 @@ title: Execute_FIToFICustomerCreditTransferV13
type: object
properties:
GrpHdr:
- description: >
- GroupHeader.
- $ref: ./GroupHeader129.yaml
+ allOf:
+ - $ref: ./GroupHeader129.yaml
+ - description: >
+ Group Header
+
+ Set of characteristics shared by all individual transactions included in the message.
CdtTrfTxInf:
- description: >
- CreditTransferTransactionInformation.
- $ref: ./CreditTransferTransaction67.yaml
+ allOf:
+ - $ref: ./CreditTransferTransaction67.yaml
+ - description: >
+ Credit Transfer Transaction Information
+
+ Set of elements providing information specific to the individual credit transfer(s).
required:
- GrpHdr
- CdtTrfTxInf
@@ -27,26 +33,6 @@ example:
Nm: John Doe
SttlmAcctSvcr:
BICFI: 123
- CdtTrfTxInf:
- PmtId:
- InstrId: 123
- EndToEndId: 123
- PmtTpInf:
- InstrPrty: NORM
- InstdAmt:
- Amt: 123
- Ccy: EUR
- ChrgBr: SLEV
- CdtrAgt:
- FinInstnId:
- BICFI: 123
- Cdtr:
- Nm: John Doe
- CdtrAcct:
- Id:
- IBAN: 123
- RmtInf:
- Ustrd: Test
CdtTrfTxInf:
PmtId:
InstrId: 123
@@ -66,4 +52,4 @@ example:
Id:
IBAN: 123
RmtInf:
- Ustrd: Test
+ Ustrd: Test
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml
index 15bdfe28..a04a583f 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml
@@ -1,4 +1,6 @@
title: ExternalChargeType1Code
+description: >
+ Specifies the type of charge applied to the transaction.
type: string
minLength: 1
maxLength: 4
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml
index f75bdfb8..3cc8b3c1 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml
@@ -1,4 +1,6 @@
title: ExternalClearingSystemIdentification1Code
+description: >
+ Specifies the external clearing system identification code.
type: string
minLength: 1
maxLength: 5
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml
index fac6fded..4891b73e 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml
@@ -1,4 +1,5 @@
title: ExternalCreditorAgentInstruction1Code
+description: Specifies the instruction given by the creditor to the creditor agent.
type: string
minLength: 1
maxLength: 4
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml
index 0298ff88..932455a3 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml
@@ -1,4 +1,5 @@
title: ExternalFinancialInstitutionIdentification1Code
+description: Specifies the external financial institution identification code.
type: string
minLength: 1
maxLength: 4
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml
index 3f070cb9..af524733 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml
@@ -1,4 +1,5 @@
title: ExternalLocalInstrument1Code
+description: Specifies the external local instrument identification code.
type: string
minLength: 1
maxLength: 35
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml
index 25af3cf1..06999553 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml
@@ -1,4 +1,5 @@
title: ExternalOrganisationIdentification1Code
+description: Specifies the external organisation identification code.
type: string
minLength: 1
maxLength: 4
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml
index 29ceda9b..7f0195be 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml
@@ -1,4 +1,5 @@
title: ExternalPaymentTransactionStatus1Code
+description: Specifies the external payment transaction status code.
type: string
minLength: 1
maxLength: 4
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml
index 4dbaa97d..5afb54bb 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml
@@ -1,4 +1,5 @@
title: ExternalPersonIdentification1Code
+description: Specifies the external person identification code.
type: string
minLength: 1
maxLength: 4
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml
index 2ce7bf77..c73485df 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml
@@ -1,4 +1,5 @@
title: ExternalProxyAccountType1Code
+description: Specifies the external proxy account type code.
type: string
minLength: 1
maxLength: 4
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml
index ba9a1cdd..f89f85cc 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml
@@ -1,4 +1,5 @@
title: ExternalPurpose1Code
+description: Specifies the external purpose code.
type: string
minLength: 1
maxLength: 4
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml
index ef347616..f1df5d01 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml
@@ -1,4 +1,5 @@
title: ExternalServiceLevel1Code
+description: Specifies the external service level code.
type: string
minLength: 1
maxLength: 4
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml
index 987ecbe7..9c519db1 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml
@@ -1,4 +1,6 @@
title: ExternalStatusReason1Code
+description: Specifies the external status reason code.
+
type: string
minLength: 1
maxLength: 4
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml
index b10499ff..b9a4d454 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml
@@ -1,4 +1,5 @@
title: ExternalVerificationReason1Code
+description: Specifies the external verification reason code.
type: string
minLength: 1
maxLength: 4
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml
index 1099cd18..009d8b11 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml
@@ -1,22 +1,27 @@
title: FinancialIdentificationSchemeName1Choice
type: object
-properties:
- Cd:
- description: >
- Code
-
- Name of the identification scheme, in a coded form as published in an external list.
- $ref: ./ExternalFinancialInstitutionIdentification1Code.yaml
- Prtry:
- description: >
- Proprietary
-
- Name of the identification scheme, in a free text form.
- $ref: ./Max35Text.yaml
+description: >
+ Specifies the name of the identification scheme.
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalFinancialInstitutionIdentification1Code.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: BIC
+ Cd: BIC
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml
index 8604638f..fe9193db 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml
@@ -1,44 +1,53 @@
title: FinancialInstitutionIdentification18
type: object
+description: >
+ Information used to identify a financial institution.
properties:
BICFI:
- description: >
- BICFI
+ allOf:
+ - $ref: ./BICFIDec2014Identifier.yaml
+ - description: >
+ BICFI
- Code allocated to a financial institution by the ISO 9362 Registration Authority as described
- in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)"
- $ref: ./BICFIDec2014Identifier.yaml
- ClrSysMmbId:
- description: >
- ClearingSystemMemberIdentification
+ Code allocated to a financial institution by the ISO 9362 Registration Authority as described
+ in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)"
+ ClrSysMmbId:
+ allOf:
+ - $ref: ./ClearingSystemMemberIdentification2.yaml
+ - description: >
+ ClearingSystemMemberIdentification
- Information used to identify a member within a clearing system
- $ref: ./ClearingSystemMemberIdentification2.yaml
+ Information used to identify a member within a clearing system
LEI:
- description: >
- LEI
+ allOf:
+ - $ref: ./LEIIdentifier.yaml
+ - description: >
+ LEI
- Legal entity identifier of the financial institution.
- $ref: ./LEIIdentifier.yaml
+ Legal entity identifier 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: >
- PostalAddress
+ allOf:
+ - $ref: ./PostalAddress24.yaml
+ - description: >
+ PostalAddress
- 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.
Othr:
- description: >
- Other
+ allOf:
+ - $ref: ./GenericFinancialIdentification1.yaml
+ - description: >
+ Other
- Unique identification of an agent, as assigned by an institution, using an identification
- scheme.
- $ref: ./GenericFinancialIdentification1.yaml
+ Unique identification of an agent, as assigned by an institution, using an identification
+ scheme.
+required: []
example:
BICFI: J5BMVH7D
ClrSysMmbId:
@@ -62,4 +71,4 @@ example:
SchmeNm:
Cd: 123
Prtry: 123
- Issr: 123
+ Issr: 123
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml
index 4329c5d7..1e188b93 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml
@@ -1,50 +1,58 @@
title: FinancialInstitutionIdentification23
type: object
+description: >
+ Information used to identify a financial institution.
properties:
BICFI:
- description: >
- BICFI
+ allOf:
+ - $ref: ./BICFIDec2014Identifier.yaml
+ - description: >
+ BICFI
- Code allocated to a financial institution by the ISO 9362 Registration Authority as described
- in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)"
- $ref: ./BICFIDec2014Identifier.yaml
+ Code allocated to a financial institution by the ISO 9362 Registration Authority as described
+ in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)"
ClrSysMmbId:
- description: >
- ClearingSystemMemberIdentification
+ allOf:
+ - $ref: ./ClearingSystemMemberIdentification2.yaml
+ - description: >
+ ClearingSystemMemberIdentification
- Information used to identify a member within a clearing system
- $ref: ./ClearingSystemMemberIdentification2.yaml
+ Information used to identify a member within a clearing system
LEI:
- description: >
- LEI
+ allOf:
+ - $ref: ./LEIIdentifier.yaml
+ - description: >
+ LEI
- Legal entity identifier of the financial institution.
- $ref: ./LEIIdentifier.yaml
+ Legal entity identifier 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: >
- PostalAddress
+ allOf:
+ - $ref: ./PostalAddress24.yaml
+ - description: >
+ PostalAddress
- Information that locates and identifies a specific address, as defined by postal services.
- $ref: ./PostalAddress27.yaml
+ Information that locates and identifies a specific address, as defined by postal services.
Othr:
- description: >
- Other
+ allOf:
+ - $ref: ./GenericFinancialIdentification1.yaml
+ - description: >
+ Other
- Unique identification of an agent, as assigned by an institution, using an identification
- scheme.
- $ref: ./GenericFinancialIdentification1.yaml
+ Unique identification of an agent, as assigned by an institution, using an identification
+ scheme.
+required: []
example:
BICFI: J5BMVH7D
ClrSysMmbId:
- ClrSysId:
- Cd: CHQB
- MmbId: 123456789
+ ClrSysId: 1234
+ MmbId: 123
LEI: 123
Nm: Name
PstlAdr:
@@ -61,5 +69,6 @@ example:
Othr:
Id: 123
SchmeNm:
- Cd: CHQB
- Issr: 123
+ Cd: 123
+ Prtry: 123
+ Issr: 123
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml
index be0ad47e..e0108829 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml
@@ -1,12 +1,17 @@
title: FxRequest_FICreditTransferProposal
type: object
+description: >
+ FxRequest_FICreditTransferProposal
+
+ A group of elements providing information specific to the individual credit transfer(s) included in the message.
properties:
GrpHdr:
- description: >
- GroupHeader
+ allOf:
+ - $ref: ./GroupHeader113.yaml
+ - description: >
+ GroupHeader
- Set of characteristics shared by all individual transactions included in the message.
- $ref: ./GroupHeader113.yaml
+ Set of characteristics shared by all individual transactions included in the message.
required:
- GrpHdr
example:
@@ -82,4 +87,4 @@ example:
FinInstnId:
BICFI: BIC
Cdtr:
- Nm: Name
+ Nm: Name
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml
index fcd04f00..ccd39475 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml
@@ -1,18 +1,24 @@
title: FxResponse_FICreditTransferConfirmation
type: object
+description: >
+ FxResponse_FICreditTransferConfirmation
+
+ The FxResponse_FICreditTransferConfirmation message is sent by the FSP to the Payer FSP to confirm the successful processing of the credit transfer.
properties:
GrpHdr:
- description: >
- GroupHeader
+ allOf:
+ - $ref: ./GroupHeader113.yaml
+ - description: >
+ GroupHeader
- Set of characteristics shared by all individual transactions included in the message.
- $ref: ./GroupHeader113.yaml
+ Set of characteristics shared by all individual transactions included in the message.
CdtTrfTxInf:
- description: >
- CreditTransferTransactionInformation
+ allOf:
+ - $ref: ./CreditTransferTransaction68.yaml
+ - description: >
+ CreditTransferTransactionInformation
- Set of elements providing information specific to the individual credit transfer(s).
- $ref: ./CreditTransferTransaction68.yaml
+ Set of elements providing information specific to the individual credit transfer(s).
required:
- GrpHdr
- CdtTrfTxInf
@@ -86,4 +92,4 @@ example:
Tp:
Cd: CACC
Ccy: EUR
- Nm: My account
+ Nm: My account
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml
index 527ba2fd..251f4486 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml
@@ -1,18 +1,22 @@
title: Fxecute_FinancialInstitutionCreditTransferV12
type: object
+description: >
+ The Fxecute FinancialInstitutionCreditTransfer message is sent by the initiating party to the executing party to request the execution of a payment. It is used to request movement of funds from the debtor account to the creditor account. The message can carry multiple credit transfer instructions.
properties:
GrpHdr:
- description: >
- GroupHeader.
+ allOf:
+ - $ref: ./GroupHeader129.yaml
+ - description: >
+ GroupHeader.
- Set of characteristics shared by all individual transactions included in the message.
- $ref: ./GroupHeader129.yaml
+ Set of characteristics shared by all individual transactions included in the message.
CdtTrfTxInf:
- description: >
- CreditTransferTransactionInformation.
+ allOf:
+ - $ref: ./CreditTransferTransaction68.yaml
+ - description: >
+ CreditTransferTransactionInformation.
- Set of elements providing information specific to the individual credit transfer(s).
- $ref: ./CreditTransferTransaction68.yaml
+ Set of elements providing information specific to the individual credit transfer(s).
required:
- GrpHdr
- CdtTrfTxInf
@@ -62,4 +66,4 @@ example:
Id:
IBAN: BE71096123456769
RmtInf:
- Ustrd: Payment for invoice 12345
+ Ustrd: Payment for invoice 12345
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml
index 410bdc75..5d8f3052 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml
@@ -1,28 +1,35 @@
title: GenericAccountIdentification1
type: object
+description: >
+ GenericAccountIdentification
+
+ Unique and unambiguous identification of an account, as assigned by the account servicer.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: ./Max34Text.yaml
+ - description: >
+ Identification
- Identification assigned by an institution.
- $ref: ./Max34Text.yaml
+ Identification assigned by an institution.
SchmeNm:
- description: >
- SchemeName
+ allOf:
+ - $ref: ./AccountSchemeName1Choice.yaml
+ - description: >
+ SchemeName
- Name of the identification scheme.
- $ref: ./AccountSchemeName1Choice.yaml
+ Name of the identification scheme.
Issr:
- description: >
- Issuer
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Issuer
- Entity that assigns the identification.
- $ref: ./Max35Text.yaml
+ Entity that assigns the identification.
required:
- Id
example:
Id: 123
SchmeNm:
Cd: IBAN
- Issr: BIC
+ Issr: BIC
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml
index 87a2befd..cbb53e52 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml
@@ -1,28 +1,35 @@
title: GenericFinancialIdentification1
type: object
+description: >
+ GenericFinancialIdentification
+
+ Unique and unambiguous identification of a person, which is used to refer to a person in a financial context.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Identification
- Unique and unambiguous identification of a person.
- $ref: ./Max35Text.yaml
+ Unique and unambiguous identification of a person.
SchmeNm:
- description: >
- SchemeName
+ allOf:
+ - $ref: ./FinancialIdentificationSchemeName1Choice.yaml
+ - description: >
+ SchemeName
- Name of the identification scheme.
- $ref: ./FinancialIdentificationSchemeName1Choice.yaml
+ Name of the identification scheme.
Issr:
- description: >
- Issuer
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Issuer
- Entity that assigns the identification.
- $ref: ./Max35Text.yaml
+ Entity that assigns the identification.
required:
- Id
example:
Id: 123
SchmeNm:
Cd: IBAN
- Issr: BIC
+ Issr: BIC
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml
index 782a9e9b..e6f9560a 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml
@@ -1,21 +1,25 @@
title: GenericIdentification3
type: object
+description: >
+ Generic scheme identification for a party.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Identification
- Name or number assigned by an entity to enable recognition of that entity, for example,
- account identifier.
- $ref: ./Max35Text.yaml
+ Name or number assigned by an entity to enable recognition of that entity, for example,
+ account identifier.
Issr:
- description: >
- Issuer
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Issuer
- Entity that assigns the identification.
- $ref: ./Max35Text.yaml
+ Entity that assigns the identification.
required:
- Id
example:
Id: 123
- Issr: BIC
+ Issr: BIC
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml
index 126a3f28..89754788 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml
@@ -1,28 +1,33 @@
title: GenericIdentification30
type: object
+description: >
+ Generic scheme identification for a party.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: ./Exact4AlphaNumericText.yaml
+ - description: >
+ Identification
- Proprietary information, often a code, issued by the data source scheme issuer
- $ref: ./Exact4AlphaNumericText.yaml
+ Proprietary information, often a code, issued by the data source scheme issuer.
Issr:
- description: >
- Issuer
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Issuer
- Entity that assigns the identification.
- $ref: ./Max35Text.yaml
+ Entity that assigns the identification.
SchmeNm:
- description: >
- SchemeName
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ SchemeName
- Short textual description of the scheme.
- $ref: ./Max35Text.yaml
+ Short textual description of the scheme.
required:
- Id
- Issr
example:
Id: 1234
Issr: BIC
- SchmeNm: BICFI
+ SchmeNm: BICFI
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml
index 22ac3333..01d4b597 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml
@@ -1,24 +1,29 @@
title: GenericOrganisationIdentification1
type: object
+description: >
+ Information that locates and identifies an organisation.
properties:
Id:
- description: >
- Identification
-
- Identification assigned by an institution.
- $ref: ./Max35Text.yaml
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Identification for an organisation.
+ FSPIOP equivalent to Party Identifier for an organisation in ISO 20022.
+ Identification assigned by an institution.
SchmeNm:
- description: >
- SchemeName
+ allOf:
+ - $ref: ./OrganisationIdentificationSchemeName1Choice.yaml
+ - description: >
+ SchemeName
- Name of the identification scheme.
- $ref: ./OrganisationIdentificationSchemeName1Choice.yaml
+ Name of the identification scheme.
Issr:
- description: >
- Issuer
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Issuer
- Entity that assigns the identification.
- $ref: ./Max35Text.yaml
+ Entity that assigns the identification.
required:
- Id
example:
@@ -26,3 +31,4 @@ example:
SchmeNm:
Cd: BIC
Issr: BIC
+
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml
index c41a55b6..0e6d1828 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml
@@ -1,28 +1,33 @@
title: GenericOrganisationIdentification3
type: object
+description: >
+ Information related to an identification of an organisation.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: ./Max256Text.yaml
+ - description: >
+ Identification
- Identification assigned by an institution.
- $ref: ./Max256Text.yaml
+ Identification assigned by an institution.
SchmeNm:
- description:
- SchemeName
+ allOf:
+ - $ref: ./OrganisationIdentificationSchemeName1Choice.yaml
+ - description: >
+ SchemeName
- Name of the identification scheme.
- $ref: ./OrganisationIdentificationSchemeName1Choice.yaml
+ Name of the identification scheme.
Issr:
- description: >
- Issuer
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Issuer
- Entity that assigns the identification.
- $ref: ./Max35Text.yaml
+ Entity that assigns the identification.
required:
- Id
example:
Id: 123
SchmeNm:
Cd: BIC
- Issr: BIC
+ Issr: BIC
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml
index 9e8299fb..ba425c68 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml
@@ -1,28 +1,35 @@
title: GenericPersonIdentification1
type: object
+description: >
+ GenericPersonIdentification1
+
+ Information that locates and identifies a specific person.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Identification
- Unique and unambiguous identification of a person.
- $ref: ./Max35Text.yaml
+ Unique and unambiguous identification of a person.
SchmeNm:
- description: >
- SchemeName
+ allOf:
+ - $ref: ./PersonIdentificationSchemeName1Choice.yaml
+ - description: >
+ SchemeName
- Name of the identification scheme.
- $ref: ./PersonIdentificationSchemeName1Choice.yaml
+ Name of the identification scheme.
Issr:
- description: >
- Issuer
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Issuer
- Entity that assigns the identification.
- $ref: ./Max35Text.yaml
+ Entity that assigns the identification.
required:
- Id
example:
Id: 123
SchmeNm:
Cd: DRLC
- Issr: BIC
+ Issr: BIC
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml
index 27c9896b..7d24897e 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml
@@ -1,28 +1,33 @@
title: GenericPersonIdentification2
type: object
+description:
+ Identification of a person.
properties:
Id:
- description: >
- Identification
+ allOf:
+ - $ref: ./Max256Text.yaml
+ - description: >
+ Identification
- Unique and unambiguous identification of a person.
- $ref: ./Max256Text.yaml
+ Unique and unambiguous identification of a person.
SchmeNm:
- description: >
- SchemeName
+ allOf:
+ - $ref: ./PersonIdentificationSchemeName1Choice.yaml
+ - description: >
+ SchemeName
- Name of the identification scheme.
- $ref: ./PersonIdentificationSchemeName1Choice.yaml
+ Name of the identification scheme.
Issr:
- description: >
- Issuer
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Issuer
- Entity that assigns the identification.
- $ref: ./Max35Text.yaml
+ Entity that assigns the identification.
required:
- Id
example:
Id: 123
SchmeNm:
Cd: DRLC
- Issr: BIC
+ Issr: BIC
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml
index bc8c79db..f8fa10eb 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml
@@ -2,24 +2,27 @@ title: GetPartiesError_IdentificationVerificationReportV03
type: object
properties:
Assgnmt:
- description: >
- Assignment
+ allOf:
+ - $ref: ./IdentificationAssignment3.yaml
+ - description: >
+ Assignment
- Information related to the identification assignment.
- $ref: ./IdentificationAssignment3.yaml
+ Information related to the identification assignment.
Rpt:
- description: >
- Report
+ allOf:
+ - $ref: ./VerificationReport4.yaml
+ - description: >
+ Report
- Information concerning the verification of the identification data for which verification was
- requested.
- $ref: ./VerificationReport4.yaml
+ Information concerning the verification of the identification data for which verification was
+ requested.
SplmtryData:
- description: >
- SupplementaryData
+ allOf:
+ - $ref: ./SupplementaryData1.yaml
+ - description: >
+ SupplementaryData
- Additional information that cannot be captured in the structured elements and/or any other specific block.
- $ref: ./SupplementaryData1.yaml
+ Additional information that cannot be captured in the structured elements and/or any other specific block.
required:
- Assgnmt
- Rpt
@@ -67,4 +70,4 @@ example:
Envlp: 123
RltdDt: '2013-03-07'
RltdDtTp:
- Cd: 123
+ Cd: 123
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml
index e4fe8da0..85825508 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml
@@ -2,24 +2,27 @@ title: GetParties_IdentificationVerificationReportV03
type: object
properties:
Assgnmt:
- description: >
- Assignment
+ allOf:
+ - $ref: ./IdentificationAssignment3.yaml
+ - description: >
+ Assignment
- Identifies the identification assignment.
- $ref: ./IdentificationAssignment3.yaml
+ Identifies the identification assignment.
Rpt:
- description: >
- Report
+ allOf:
+ - $ref: ./VerificationReport4.yaml
+ - description: >
+ Report
- Information concerning the verification of the identification data for which verification was
- requested.
- $ref: ./VerificationReport4.yaml
+ Information concerning the verification of the identification data for which verification was
+ requested.
SplmtryData:
- description: >
- SupplementaryData
+ allOf:
+ - $ref: ./SupplementaryData1.yaml
+ - description: >
+ SupplementaryData
- Additional information that cannot be captured in the structured elements and/or any other specific block.
- $ref: ./SupplementaryData1.yaml
+ Additional information that cannot be captured in the structured elements and/or any other specific block.
required:
- Assgnmt
- Rpt
@@ -74,4 +77,4 @@ example:
PhneNb: +123-123-321
MobNb: +123-123-321
FaxNb: +123-123-321
- EmailAdr: example@example.com
+ EmailAdr: example@example.com
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml
index 68ac8542..2e78ba53 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml
@@ -5,19 +5,40 @@ description: >
type: object
properties:
MsgId:
- $ref: ./Max35Text.yaml
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Message Identification
CreDtTm:
- $ref: ./ISODateTime.yaml
+ allOf:
+ - $ref: ./ISODateTime.yaml
+ - description: >
+ Creation Date and Time
NbOfTxs:
- $ref: ./Max15NumericText.yaml
+ allOf:
+ - $ref: ./Max15NumericText.yaml
+ - description: >
+ Number of Transactions
TtlIntrBkSttlmAmt:
- $ref: ./ActiveCurrencyAndAmount.yaml
+ allOf:
+ - $ref: ./ActiveCurrencyAndAmount.yaml
+ - description: >
+ Total Interbank Settlement Amount
SttlmInf:
- $ref: ./SettlementInstruction15.yaml
+ allOf:
+ - $ref: ./SettlementInstruction15.yaml
+ - description: >
+ Settlement Information
PmtTpInf:
- $ref: ./PaymentTypeInformation28.yaml
+ allOf:
+ - $ref: ./PaymentTypeInformation28.yaml
+ - description: >
+ Payment Type Information
CdtTrfTxInf:
- $ref: ./CreditTransferTransaction68.yaml
+ allOf:
+ - $ref: ./CreditTransferTransaction68.yaml
+ - description: >
+ Credit Transfer Transaction Information
required:
- MsgId
- CreDtTm
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml
index 7b276bfa..bfa212b0 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml
@@ -5,30 +5,33 @@ description: >
type: object
properties:
MsgId:
- description: >
- MessageIdentification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ MessageIdentification
- Definition: Point to point reference, as assigned by the instructing party, and sent to the next party in the
- chain to unambiguously identify the message.
+ Definition: Point to point reference, as assigned by the instructing party, and sent to the next party in the
+ chain to unambiguously identify the message.
- Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party
- for a pre-agreed period.
- $ref: ./Max35Text.yaml
+ Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party
+ for a pre-agreed period.
CreDtTm:
- description: >
- CreationDateTime
+ allOf:
+ - $ref: ./ISODateTime.yaml
+ - description: >
+ CreationDateTime
- Date and time at which the message was created.
- $ref: ./ISODateTime.yaml
+ Date and time at which the message was created.
TxInfAndSts:
- description: >
- TransactionInformationAndStatus
+ allOf:
+ - $ref: ./PaymentTransaction163.yaml
+ - description: >
+ TransactionInformationAndStatus
- Definition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).
+ Definition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).
- Usage: The instructing agent is the party sending the status message and not the party that sent the
- original instruction that is being reported on.
- $ref: ./PaymentTransaction163.yaml
+ Usage: The instructing agent is the party sending the status message and not the party that sent the
+ original instruction that is being reported on.
required:
- MsgId
- CreDtTm
@@ -51,4 +54,4 @@ example:
ExctnConf: 1234567890ABCDEF
SplmtryData:
PlcAndNm: PLACE
- Envlp: ENVELOPE
+ Envlp: ENVELOPE
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml
index e4c0a9b0..af257edb 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml
@@ -1,21 +1,39 @@
title: GroupHeader129
description: >
- Set of characteristics shared by all individual transactions included in the
+ Group Header Set of characteristics shared by all individual transactions included in the
message.
type: object
properties:
MsgId:
- $ref: ./Max35Text.yaml
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Message Identification
CreDtTm:
- $ref: ./ISODateTime.yaml
+ allOf:
+ - $ref: ./ISODateTime.yaml
+ - description: >
+ Creation Date and Time
PmtInstrXpryDtTm:
- $ref: ./ISODateTime.yaml
+ allOf:
+ - $ref: ./ISODateTime.yaml
+ - description: >
+ Payment Instruction Expiry Date and Time
NbOfTxs:
- $ref: ./Max15NumericText.yaml
+ allOf:
+ - $ref: ./Max15NumericText.yaml
+ - description: >
+ Number of Transactions
SttlmInf:
- $ref: ./SettlementInstruction15.yaml
+ allOf:
+ - $ref: ./SettlementInstruction15.yaml
+ - description: >
+ Settlement Information
CdtTrfTxInf:
- $ref: ./CreditTransferTransaction67.yaml
+ allOf:
+ - $ref: ./CreditTransferTransaction67.yaml
+ - description: >
+ Credit Transfer Transaction Information
required:
- MsgId
- CreDtTm
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml
index 74715d6d..705909d8 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml
@@ -1,28 +1,40 @@
title: IdentificationAssignment3
type: object
+description: >
+ IdentificationAssignment
+
+ Information that unambiguously identifies a message, as assigned by the assignor to the assignee.
properties:
MsgId:
- $ref: ./Max35Text.yaml
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ MessageIdentification
+
+ Unique identification, as assigned by the assigner, to unambiguously identify the message.
CreDtTm:
- description: >
- CreationDateTime
+ allOf:
+ - $ref: ./ISODateTime.yaml
+ - description: >
+ CreationDateTime
- Date and time at which the identification assignment was created.
- $ref: ./ISODateTime.yaml
+ Date and time at which the identification assignment was created.
Assgnr:
- description: >
- Assignor
+ allOf:
+ - $ref: ./Party40Choice.yaml
+ - description: >
+ Assignor
- Party that assigns the identification assignment to another party. This is also the sender of
- the message.
- $ref: ./Party40Choice.yaml
+ Party that assigns the identification assignment to another party. This is also the sender of
+ the message.
Assgne:
- description: >
- Assignee
+ allOf:
+ - $ref: ./Party40Choice.yaml
+ - description: >
+ Assignee
- Party that the identification assignment is assigned to. This is also the receiver of the
- message.
- $ref: ./Party40Choice.yaml
+ Party that the identification assignment is assigned to. This is also the receiver of the
+ message.
required:
- MsgId
- CreDtTm
@@ -44,4 +56,4 @@ example:
Id: 123
SchmeNm:
Cd: BIC
- Issr: BIC
+ Issr: BIC
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml
index 561a8c7e..7e36b93a 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml
@@ -1,24 +1,31 @@
title: IdentificationInformation4
type: object
+description: >
+ Information that locates and identifies a specific party or account.
properties:
Pty:
- description: >
- Party
+ allOf:
+ - $ref: ./PartyIdentification135.yaml
+ - description: >
+ Party
- Account owner that owes an amount of money or to whom an amount of money is due.
- $ref: ./PartyIdentification135.yaml
+ Account owner that owes an amount of money or to whom an amount of money is due.
Acct:
- description: >
- Account
+ allOf:
+ - $ref: ./CashAccount40.yaml
+ - description: >
+ Account
- Unambiguous identification of the account of a party.
- $ref: ./CashAccount40.yaml
+ Unambiguous identification of the account of a party.
Agt:
- description: >
- Agent
+ allOf:
+ - $ref: ./BranchAndFinancialInstitutionIdentification6.yaml
+ - description: >
+ Agent
- Financial institution servicing an account for a party.
- $ref: ./BranchAndFinancialInstitutionIdentification6.yaml
+ Financial institution servicing an account for a party.
+required:
+ - Pty
example:
Pty:
Id:
@@ -31,4 +38,4 @@ example:
IBAN: FI2112345600000785
Agt:
FinInstnId:
- BICFI: BICFI
+ BICFI: BICFI
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml
index 714ae57c..a4061742 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml
@@ -1,12 +1,10 @@
title: Instruction4Code
-description: >
+description: |
Specifies further instructions concerning the processing of a payment
instruction, provided by the sending clearing agent to the next agent(s).
- PHOA PhoneNextAgent Please advise/contact next agent by phone.
-
- TELA TelecomNextAgent Please advise/contact next agent by the most efficient
- means of telecommunication.
+ PHOA: PhoneNextAgent Please advise/contact next agent by phone.
+ TELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.
type: string
enum:
- PHOA
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml
index 48108bd6..f4221a34 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml
@@ -5,19 +5,21 @@ description: >
type: object
properties:
Cd:
- description: >
- Code
+ allOf:
+ - $ref: ./ExternalCreditorAgentInstruction1Code.yaml
+ - description: >
+ Code
- Coded information related to the processing of the payment instruction, provided by the
- initiating party, and intended for the creditor's agent.
- $ref: ./ExternalCreditorAgentInstruction1Code.yaml
+ Coded information related to the processing of the payment instruction, provided by the
+ initiating party, and intended for the creditor's agent.
InstrInf:
- description: >
- InstructionInformation
+ allOf:
+ - $ref: ./Max140Text.yaml
+ - description: >
+ InstructionInformation
- Further information complementing the coded instruction or instruction to the creditor's agent
- that is bilaterally agreed or specific to a user community.
- $ref: ./Max140Text.yaml
+ Further information complementing the coded instruction or instruction to the creditor's agent
+ that is bilaterally agreed or specific to a user community.
example:
Cd: PHOA
- InstrInf: Please advise/contact next agent by phone.
+ InstrInf: Please advise/contact next agent by phone.
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml
index 8570781e..54180827 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml
@@ -1,23 +1,25 @@
title: InstructionForNextAgent1
description: >
Further information related to the processing of the payment instruction,
- provided by the initiating party, and intended for the creditor agent.
+ provided by the initiating party, and intended for the next agent in the payment chain.
type: object
properties:
Cd:
- description: >
- Code
+ allOf:
+ - $ref: ./Instruction4Code.yaml
+ - description: >
+ Code
- Coded information related to the processing of the payment instruction, provided by the
- initiating party, and intended for the next agent in the payment chain.
- $ref: ./Instruction4Code.yaml
+ Coded information related to the processing of the payment instruction, provided by the
+ initiating party, and intended for the next agent in the payment chain.
InstrInf:
- description: >
- InstructionInformation
+ allOf:
+ - $ref: ./Max140Text.yaml
+ - description: >
+ InstructionInformation
- Further information complementing the coded instruction or instruction to the next agent that
- is bilaterally agreed or specific to a user community.
- $ref: ./Max140Text.yaml
+ Further information complementing the coded instruction or instruction to the next agent that
+ is bilaterally agreed or specific to a user community.
example:
Cd: PHOA
- InstrInf: Please advise/contact next agent by phone
+ InstrInf: Please advise/contact next agent by phone.
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml
index f6b04b89..7d33b034 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml
@@ -1,22 +1,27 @@
title: LocalInstrument2Choice
type: object
-properties:
- Cd:
- description: >
- Code
-
- Specifies the local instrument, as published in an external local instrument code list.
- $ref: ./ExternalLocalInstrument1Code.yaml
- Prtry:
- description: >
- Proprietary
-
- Specifies the local instrument, as a proprietary code
- $ref: ./Max35Text.yaml
+description: >
+ Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalLocalInstrument1Code.yaml
+ - description: >
+ Code
+
+ Specifies the local instrument, as published in an external local instrument code list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Proprietary
+
+ Specifies the local instrument, as a proprietary code.
+ required:
- Prtry
example:
- Cd: CH03
+ Cd: CH03
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml
index 4fc6a951..33c283a6 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml
@@ -1,5 +1,11 @@
description: |
Specifies the terms used to formally address a person.
+
+ DOCT: Doctor or Dr
+ MADM: Madam
+ MISS: Miss
+ MIST: Mistress
+ MIKS: Mx
enum:
- DOCT
- MADM
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml
index 8b295e88..abca9558 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml
@@ -4,23 +4,26 @@ description: |
type: object
properties:
AnyBIC:
- description: >
- AnyBIC
+ allOf:
+ - $ref: ./AnyBICDec2014Identifier.yaml
+ - description: >
+ AnyBIC
- Business identification code of the organisation.
- $ref: ./AnyBICDec2014Identifier.yaml
+ Business identification code of the organisation.
LEI:
- description: >
- LEI
+ allOf:
+ - $ref: ./LEIIdentifier.yaml
+ - description: >
+ LEI
- Legal entity identification as an alternate identification for a party.
- $ref: ./LEIIdentifier.yaml
+ Legal entity identification as an alternate identification for a party.
Othr:
- description: >
- Other
+ allOf:
+ - $ref: ./GenericOrganisationIdentification1.yaml
+ - description: >
+ Other
- Unique identification of an organisation, as assigned by an institution, using an identification scheme.
- $ref: ./GenericOrganisationIdentification1.yaml
+ Unique identification of an organisation, as assigned by an institution, using an identification scheme.
example:
AnyBIC: BICFI
LEI: 529900T8BM49AURSDO55
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml
index f64f4205..1f345029 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml
@@ -4,23 +4,26 @@ description: |
type: object
properties:
AnyBIC:
- description: >
- AnyBIC
+ allOf:
+ - $ref: ./AnyBICDec2014Identifier.yaml
+ - description: >
+ AnyBIC
- Business identification code of the organisation.
- $ref: ./AnyBICDec2014Identifier.yaml
+ Business identification code of the organisation.
LEI:
- description: >
- LEI
+ allOf:
+ - $ref: ./LEIIdentifier.yaml
+ - description: >
+ LEI
- Legal entity identification as an alternate identification for a party.
- $ref: ./LEIIdentifier.yaml
+ Legal entity identification as an alternate identification for a party.
Othr:
- description: >
- Other
+ allOf:
+ - $ref: ./GenericOrganisationIdentification3.yaml
+ - description: >
+ Other
- Unique identification of an organisation, as assigned by an institution, using an identification scheme.
- $ref: ./GenericOrganisationIdentification3.yaml
+ Unique identification of an organisation, as assigned by an institution, using an identification scheme.
example:
AnyBIC: BICFI
LEI: 529900T8BM49AURSDO55
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml
index bf5f5b0f..350f1cd8 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml
@@ -4,21 +4,23 @@ description: |
type: object
properties:
Cd:
- description: >
- Code
+ allOf:
+ - $ref: ./ExternalOrganisationIdentification1Code.yaml
+ - description: >
+ Code
- Name of the identification scheme, in a coded form as published in an external list.
- $ref: ./ExternalOrganisationIdentification1Code.yaml
+ Name of the identification scheme, in a coded form as published in an external list.
Prtry:
- description: >
- Proprietary
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Proprietary
- Name of the identification scheme, in a free text form.
- $ref: ./Max35Text.yaml
+ Name of the identification scheme, in a free text form.
oneOf:
- - required:
- - Cd
- - required:
- - Prtry
+ - properties:
+ Cd: {}
+ - properties:
+ Prtry: {}
example:
Cd: BIC
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml
index a7657f22..3ec899af 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml
@@ -4,19 +4,21 @@ description: |
type: object
properties:
ChanlTp:
- description: >
- ChannelType
+ allOf:
+ - $ref: ./Max4Text.yaml
+ - description: >
+ ChannelType
- Method used to contact the financial institution's contact for the specific tax region.
- $ref: ./Max4Text.yaml
+ Method used to contact the financial institution's contact for the specific tax region.
Id:
- description: >
- Identifier
+ allOf:
+ - $ref: ./Max128Text.yaml
+ - description: >
+ Identifier
- Communication value such as phone number or email address.
- $ref: ./Max128Text.yaml
+ Communication value such as phone number or email address.
required:
- ChanlTp
example:
ChanlTp: PHON
- Id: 1234567890
+ Id: 1234567890
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml
index dabbb771..cdb24f19 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml
@@ -1,12 +1,24 @@
title: PacsError_FIToFIPaymentStatusReportV15
type: object
+description: >
+ This message is sent by an account servicing institution to an account owner. It is used to inform the account owner about the status of a payment initiation.
+
properties:
GrpHdr:
- $ref: ./GroupHeader120.yaml
+ allOf:
+ - $ref: ./GroupHeader120.yaml
+ - description: >
+ Set of characteristics shared by all individual transactions included in the message.
TxInfAndSts:
- $ref: ./PaymentTransaction163.yaml
+ allOf:
+ - $ref: ./PaymentTransaction163.yaml
+ - description: >
+ Information concerning the original transactions, to which the status report message refers.
SplmtryData:
- $ref: ./SupplementaryData1.yaml
+ allOf:
+ - $ref: ./SupplementaryData1.yaml
+ - description: >
+ Additional information that cannot be captured in the structured elements and/or any other specific block.
required:
- GrpHdr
example:
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml
index dd9e45a1..aa3003a2 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml
@@ -1,10 +1,13 @@
title: PacsStatus_FIToFIPaymentStatusReportV15
-description: |
- Unsure on description.
+description:
+ The PacsStatus message is sent by a financial institution to another financial institution as a response to the FIToFIPaymentStatusReport message. The message provides information on the status of a payment instruction and its underlying individual transactions.
type: object
properties:
GrpHdr:
- $ref: ./GroupHeader120.yaml
+ allOf:
+ - $ref: ./GroupHeader120.yaml
+ - description: >
+ Set of characteristics shared by all individual transactions included in the message.
required:
- GrpHdr
example:
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml
index c51404ba..86b8d299 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml
@@ -2,23 +2,26 @@ title: Party38Choice
description: |
Nature or use of the account.
type: object
-properties:
- OrgId:
- description: >
- Organisation
-
- Unique and unambiguous way to identify an organisation.
- $ref: ./OrganisationIdentification29.yaml
- PrvtId:
- description: >
- PrivateIdentification
-
- Unique and unambiguous identification of a person, for example a passport.
- $ref: ./PersonIdentification13.yaml
oneOf:
- - required:
+ - properties:
+ OrgId:
+ allOf:
+ - $ref: ./OrganisationIdentification29.yaml
+ - description: >
+ Organisation
+
+ Unique and unambiguous way to identify an organisation.
+ required:
- OrgId
- - required:
+ - properties:
+ PrvtId:
+ allOf:
+ - $ref: ./PersonIdentification13.yaml
+ - description: >
+ PrivateIdentification
+
+ Unique and unambiguous identification of a person, for example a passport.
+ required:
- PrvtId
example:
OrgId:
@@ -26,4 +29,4 @@ example:
PrvtId:
DtAndPlcOfBirth:
Dt: '2018-01-01'
- CityOfBirth: City
+ CityOfBirth: City
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml
index 024475e9..ef9ca365 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml
@@ -2,23 +2,26 @@ title: Party40Choice
description: |
Identification of a person, an organisation or a financial institution.
type: object
-properties:
- Pty:
- description: >
- Party
-
- Identification of a person or an organisation.
- $ref: ./PartyIdentification135.yaml
- Agt:
- description: >
- Agent
-
- Identification of a financial institution.
- $ref: ./BranchAndFinancialInstitutionIdentification6.yaml
oneOf:
- - required:
+ - properties:
+ Pty:
+ allOf:
+ - $ref: ./PartyIdentification135.yaml
+ - description: >
+ Party
+
+ Identification of a person or an organisation.
+ required:
- Pty
- - required:
+ - properties:
+ Agt:
+ allOf:
+ - $ref: ./BranchAndFinancialInstitutionIdentification6.yaml
+ - description: >
+ Agent
+
+ Identification of a financial institution.
+ required:
- Agt
example:
Pty:
@@ -42,4 +45,4 @@ example:
AdrLine:
- 1 Oxford Street
- London
- - UK
+ - UK
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml
index 45095f52..2bc9e3f3 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml
@@ -2,23 +2,26 @@ title: Party52Choice
description: |
NOTE: Unsure on the description.
type: object
-properties:
- OrgId:
- description: >
- Organisation
-
- Unique and unambiguous way to identify an organisation.
- $ref: ./OrganisationIdentification39.yaml
- PrvtId:
- description: >
- Person
-
- Unique and unambiguous identification of a person, for example a passport
- $ref: ./PersonIdentification18.yaml
oneOf:
- - required:
+ - properties:
+ OrgId:
+ allOf:
+ - $ref: ./OrganisationIdentification39.yaml
+ - description: >
+ Organisation
+
+ Unique and unambiguous way to identify an organisation.
+ required:
- OrgId
- - required:
+ - properties:
+ PrvtId:
+ allOf:
+ - $ref: ./PersonIdentification18.yaml
+ - description: >
+ Person
+
+ Unique and unambiguous identification of a person, for example a passport.
+ required:
- PrvtId
example:
OrgId:
@@ -26,4 +29,4 @@ example:
PrvtId:
DtAndPlcOfBirth:
Dt: '2018-01-01'
- CityOfBirth: City
+ CityOfBirth: City
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml
index 74cb3baa..72b90414 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml
@@ -4,35 +4,43 @@ description: |
type: object
properties:
Nm:
- description: >
- Name
+ allOf:
+ - $ref: ./Max140Text.yaml
+ - description: >
+ Name
- Name by which a party is known and which is usually used to identify that party.
- $ref: ./Max140Text.yaml
+ Name by which a party is known and which is usually used to identify that party.
PstlAdr:
- description: >
- PostalAddress
+ allOf:
+ - $ref: ./PostalAddress24.yaml
+ - description: >
+ PostalAddress
- 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.
Id:
- description: >
- Identification
+ allOf:
+ - $ref: ./Party38Choice.yaml
+ - description: >
+ Identification
- Unique and unambiguous way to identify an organisation.
- $ref: ./Party38Choice.yaml
+ Unique and unambiguous way to identify an organisation.
CtryOfRes:
- description: >
- CountryOfResidence
- Country in which a person resides (the place of a person's home). In the case of a company,
- it is the country from which the affairs of that company are directed.
- $ref: ./CountryCode.yaml
+ allOf:
+ - $ref: ./CountryCode.yaml
+ - description: >
+ CountryOfResidence
+
+ Country in which a person resides (the place of a person's home). In the case of a company,
+ it is the country from which the affairs of that company are directed.
CtctDtls:
- description: >
- ContactDetails
+ allOf:
+ - $ref: ./Contact4.yaml
+ - description: >
+ ContactDetails
- Set of elements used to indicate how to contact the party.
- $ref: ./Contact4.yaml
+ Set of elements used to indicate how to contact the party.
+required:
+ - Id
example:
Nm: John Doe
PstlAdr:
@@ -58,7 +66,6 @@ example:
Id: 123
SchmeNm:
Prtry: DfspId
-
CtryOfRes: BE
CtctDtls:
NmPrfx: Mr
@@ -66,5 +73,4 @@ example:
PhneNb: +123-123-321
MobNb: +123-123-321
FaxNb: +123-123-321
- EmailAdr: example@example.com
-
+ EmailAdr: example@example.com
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml
index 5fb31ca7..3b366bcb 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml
@@ -4,36 +4,43 @@ description: |
type: object
properties:
Nm:
- description: >
- Name
+ allOf:
+ - $ref: ./Max140Text.yaml
+ - description: >
+ Name
- Name by which a party is known and which is usually used to identify that party.
- $ref: ./Max140Text.yaml
+ Name by which a party is known and which is usually used to identify that party.
PstlAdr:
- description: >
- Postal Address
+ allOf:
+ - $ref: ./PostalAddress27.yaml
+ - description: >
+ Postal Address
- Information that locates and identifies a specific address, as defined by postal services.
- $ref: ./PostalAddress27.yaml
+ Information that locates and identifies a specific address, as defined by postal services.
Id:
- description: >
- Identification
+ allOf:
+ - $ref: ./Party52Choice.yaml
+ - description: >
+ Identification
- Unique and unambiguous identification of a party.
- $ref: ./Party52Choice.yaml
+ Unique and unambiguous identification of a party.
CtryOfRes:
- description: >
- Country of Residence
+ allOf:
+ - $ref: ./CountryCode.yaml
+ - description: >
+ Country of Residence
- Country in which a person resides (the place of a person's home).
- In the case of a company, it is the country from which the affairs of that company are directed.
- $ref: ./CountryCode.yaml
+ Country in which a person resides (the place of a person's home).
+ In the case of a company, it is the country from which the affairs of that company are directed.
CtctDtls:
- description: >
- Contact Details
+ allOf:
+ - $ref: ./Contact13.yaml
+ - description: >
+ Contact Details
- Set of elements used to indicate how to contact the party.
- $ref: ./Contact13.yaml
+ Set of elements used to indicate how to contact the party.
+required:
+ - Id
example:
Nm: John Doe
PstlAdr:
@@ -60,4 +67,5 @@ example:
PhneNb: +123-123-321
MobNb: +123-123-321
FaxNb: +123-123-321
- EmailAdr:
+ EmailAdr: example@example.com
+
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml
index 57ce75cc..8b9681bd 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml
@@ -4,59 +4,65 @@ description: |
type: object
properties:
InstrId:
- description: >
- InstructionIdentification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ InstructionIdentification (FSPIOP equivalent: transactionRequestId)
- Definition: Unique identification, as assigned by an instructing party for an instructed party, to
- unambiguously identify the instruction.
+ Definition: Unique identification, as assigned by an instructing party for an instructed party, to
+ unambiguously identify the instruction.
- Usage: The instruction identification is a point to point reference that can be used between the
- instructing party and the instructed party to refer to the individual instruction. It can be included in
- several messages related to the instruction.
- $ref: ./Max35Text.yaml
+ Usage: The instruction identification is a point to point reference that can be used between the
+ instructing party and the instructed party to refer to the individual instruction. It can be included in
+ several messages related to the instruction.
EndToEndId:
- description: >
- EndToEndIdentification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ EndToEndIdentification (FSPIOP equivalent: transactionId)
- Definition: Unique identification, as assigned by the initiating party, to unambiguously identify the
- transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
+ Definition: Unique identification, as assigned by the initiating party, to unambiguously identify the
+ transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
- Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the
- transaction. It can be included in several messages related to the transaction.
+ Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the
+ transaction. It can be included in several messages related to the transaction.
- Usage: In case there are technical limitations to pass on multiple references, the end-to-end
- identification must be passed on throughout the entire end-to-end chain.
- $ref: ./Max35Text.yaml
+ Usage: In case there are technical limitations to pass on multiple references, the end-to-end
+ identification must be passed on throughout the entire end-to-end chain.
TxId:
- description: >
- TransactionIdentification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ TransactionIdentification (FSPIOP equivalent: quoteId)
- Definition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the
- transaction that is passed on, unchanged, throughout the entire interbank chain.
+ Definition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the
+ transaction that is passed on, unchanged, throughout the entire interbank chain.
- Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to
- the transaction on the interbank level.
+ Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to
+ the transaction on the interbank level.
- Usage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.
- $ref: ./Max35Text.yaml
+ Usage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.
UETR:
- description: >
- UETR
+ allOf:
+ - $ref: ./UUIDv4Identifier.yaml
+ - description: >
+ UETR
- Universally unique identifier to provide an end-to-end reference of a payment transaction.
- $ref: ./UUIDv4Identifier.yaml
+ Universally unique identifier to provide an end-to-end reference of a payment transaction.
ClrSysRef:
- description: >
- ClearingSystemReference
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ ClearingSystemReference
- Unique reference, as assigned by a clearing system, to unambiguously identify the
- instruction.
- $ref: ./Max35Text.yaml
+ Unique reference, as assigned by a clearing system, to unambiguously identify the
+ instruction.
required:
- - EndToEndId
+ - TxId
example:
InstrId: INSTRUCTIONID
EndToEndId: ENDTOENDID
TxId: TRANSACTIONID
UETR: 123e4567-e89b-12d3-a456-426614174000
ClrSysRef: CLRSYSREF
+
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml
index 74583165..3cdd7f90 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml
@@ -5,29 +5,80 @@ description: >
type: object
properties:
StsId:
- $ref: ./Max35Text.yaml
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Unique identification, as assigned by the original sending party, to
+ unambiguously identify the status report.
OrgnlInstrId:
- $ref: ./Max35Text.yaml
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ Unique identification, as assigned by the original sending party, to
+ unambiguously identify the original instruction.
+
+ (FSPIOP equivalent: transactionRequestId)
OrgnlEndToEndId:
- $ref: ./Max35Text.yaml
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ Unique identification, as assigned by the original sending party, to
+ unambiguously identify the original end-to-end transaction.
+
+ (FSPIOP equivalent: transactionId)
OrgnlTxId:
- $ref: ./Max35Text.yaml
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ Unique identification, as assigned by the original sending party, to
+ unambiguously identify the original transaction.
+
+ (FSPIOP equivalent: quoteId)
OrgnlUETR:
- $ref: ./UUIDv4Identifier.yaml
+ allOf:
+ - $ref: ./UUIDv4Identifier.yaml
+ - description: >
+ Unique end-to-end transaction reference, as assigned by the original
+ sending party, to unambiguously identify the original transaction.
TxSts:
- $ref: ./ExternalPaymentTransactionStatus1Code.yaml
+ allOf:
+ - $ref: ./ExternalPaymentTransactionStatus1Code.yaml
+ - description: >
+ Specifies the status of the transaction.
StsRsnInf:
- $ref: ./StatusReasonInformation14.yaml
+ allOf:
+ - $ref: ./StatusReasonInformation14.yaml
+ - description: >
+ Information concerning the reason for the status.
AccptncDtTm:
- $ref: ./ISODateTime.yaml
+ allOf:
+ - $ref: ./ISODateTime.yaml
+ - description: >
+ Date and time at which the status was accepted.
AcctSvcrRef:
- $ref: ./Max35Text.yaml
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Unique reference, as assigned by the account servicing institution, to
+ unambiguously identify the status report.
ClrSysRef:
- $ref: ./Max35Text.yaml
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Reference that is assigned by the account servicing institution and
+ sent to the account owner to unambiguously identify the transaction.
ExctnConf:
- $ref: ./Exact32HexBinaryText.yaml
+ allOf:
+ - $ref: ./Exact32HexBinaryText.yaml
+ - description: >
+ Unique reference, as assigned by the account servicing institution, to
+ unambiguously identify the confirmation.
SplmtryData:
- $ref: ./SupplementaryData1.yaml
+ allOf:
+ - $ref: ./SupplementaryData1.yaml
+ - description: >
+ Additional information that cannot be captured in the structured
+ elements and/or any other specific block.
example:
StsId: 12345
OrgnlInstrId: 12345
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml
index a0dd0e91..f51993b4 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml
@@ -4,39 +4,33 @@ description: |
type: object
properties:
InstrPrty:
- description: >
- InstructionPriority
-
- 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.
$ref: ./Priority2Code.yaml
ClrChanl:
- description: >
- ClearingChannel
-
- Specifies the clearing channel to be used to process the payment instruction.
$ref: ./ClearingChannel2Code.yaml
SvcLvl:
- description: >
- ServiceLevel
+ allOf:
+ - $ref: ./ServiceLevel8Choice.yaml
+ - description: >
+ ServiceLevel
- Agreement under which or rules under which the transaction should be processed.
- $ref: ./ServiceLevel8Choice.yaml
+ Agreement under which or rules under which the transaction should be processed.
LclInstrm:
- description: >
- LocalInstrument
+ allOf:
+ - $ref: ./LocalInstrument2Choice.yaml
+ - description: >
+ LocalInstrument
- Definition: User community specific instrument.
+ Definition: User community specific instrument.
- Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the
- service or service level.
- $ref: ./LocalInstrument2Choice.yaml
+ Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the
+ service or service level.
CtgyPurp:
- description: >
- CategoryPurpose
+ allOf:
+ - $ref: ./CategoryPurpose1Choice.yaml
+ - description: >
+ CategoryPurpose
- Specifies the high level purpose of the instruction based on a set of pre-defined categories.
- $ref: ./CategoryPurpose1Choice.yaml
+ Specifies the high level purpose of the instruction based on a set of pre-defined categories.
example:
InstrPrty: NORM
ClrChanl: RTGS
@@ -45,4 +39,4 @@ example:
LclInstrm:
Cd: CORE
CtgyPurp:
- Cd: CASH
+ Cd: CASH
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml
index 94a41d89..17c45ab2 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml
@@ -4,17 +4,19 @@ description: |
type: object
properties:
DtAndPlcOfBirth:
- description: >
- DateAndPlaceOfBirth
+ allOf:
+ - $ref: ./DateAndPlaceOfBirth1.yaml
+ - description: >
+ DateAndPlaceOfBirth
- Date and place of birth of a person.
- $ref: ./DateAndPlaceOfBirth1.yaml
+ Date and place of birth of a person.
Othr:
- description: >
- Other
+ allOf:
+ - $ref: ./GenericPersonIdentification1.yaml
+ - description: >
+ Other
- Unique identification of a person, as assigned by an institution, using an identification scheme.
- $ref: ./GenericPersonIdentification1.yaml
+ Unique identification of a person, as assigned by an institution, using an identification scheme.
example:
DtAndPlcOfBirth:
Dt: '2018-01-01'
@@ -23,4 +25,4 @@ example:
Id: 123
SchmeNm:
Cd: CUST
- Prtry: 1
+ Prtry: 1
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml
index 4a940f4b..8d25ba9b 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml
@@ -4,17 +4,19 @@ description: |
type: object
properties:
DtAndPlcOfBirth:
- description: >
- DateAndPlaceOfBirth
+ allOf:
+ - $ref: ./DateAndPlaceOfBirth1.yaml
+ - description: >
+ DateAndPlaceOfBirth
- Date and place of birth of a person.
- $ref: ./DateAndPlaceOfBirth1.yaml
+ Date and place of birth of a person.
Othr:
- description: >
- Other
+ allOf:
+ - $ref: ./GenericPersonIdentification2.yaml
+ - description: >
+ Other
- Unique identification of a person, as assigned by an institution, using an identification scheme.
- $ref: ./GenericPersonIdentification2.yaml
+ Unique identification of a person, as assigned by an institution, using an identification scheme.
example:
DtAndPlcOfBirth:
Dt: '2018-01-01'
@@ -23,4 +25,4 @@ example:
Id: 123
SchmeNm:
Cd: CUST
- Prtry: 1
+ Prtry: 1
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml
index fbd0cfa1..01c0cfb5 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml
@@ -2,23 +2,26 @@ title: PersonIdentificationSchemeName1Choice
description: |
Sets of elements to identify a name of the identification scheme.
type: object
-properties:
- Cd:
- description: >
- Code
-
- Name of the identification scheme, in a coded form as published in an external list
- $ref: ./ExternalPersonIdentification1Code.yaml
- Prtry:
- description: >
- Proprietary
-
- Name of the identification scheme, in a free text form
- $ref: ./Max35Text.yaml
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalPersonIdentification1Code.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: CCPT
+ Cd: CCPT
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml
index e9cd86de..3f644286 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml
@@ -1,6 +1,12 @@
title: PreferredContactMethod1Code
description: |
Preferred method used to reach the individual contact within an organisation.
+
+ LETT: Letter
+ MAIL: Email
+ PHON: Phone
+ FAXX: Fax
+ CELL: Mobile phone
type: string
enum:
- LETT
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml
index 41e87586..400fab01 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml
@@ -1,6 +1,11 @@
title: PreferredContactMethod2Code
description: |
Preferred method used to reach the individual contact within an organisation.
+ LETT: Letter
+ MAIL: Email
+ PHON: Phone
+ FAXX: Fax
+ CELL: Mobile phone
type: string
enum:
- LETT
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml
index e09f960a..e5437676 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml
@@ -1,7 +1,10 @@
title: Priority2Code
-description: >
+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.
+
+ HIGH: High priority
+ NORM: Normal priority
type: string
enum:
- HIGH
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml
index 5349b9a5..900ef038 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml
@@ -4,20 +4,22 @@ description: |
type: object
properties:
Tp:
- description: |
- Type
+ allOf:
+ - $ref: ./ProxyAccountType1Choice.yaml
+ - description: >
+ Type
- Type of the proxy identification.
- $ref: ./ProxyAccountType1Choice.yaml
+ Type of the proxy identification.
Id:
- description: |
- Identification
+ allOf:
+ - $ref: ./Max2048Text.yaml
+ - description: >
+ Identification
- Identification used to indicate the account identification under another specified name.
- $ref: ./Max2048Text.yaml
+ Identification used to indicate the account identification under another specified name.
required:
- Id
example:
Tp:
Cd: IBAN
- Id: 123
+ Id: 123
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml
index 7e555c60..ad6eae51 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml
@@ -1,26 +1,27 @@
title: ProxyAccountType1Choice
-type: object
description: |
- ProxyAccountType1Choice
-
- Specifies the scheme used for the identification of an account alias.
-properties:
- Cd:
- description: |
- Code
-
- Name of the identification scheme, in a coded form as published in an external list.
- $ref: ./ExternalProxyAccountType1Code.yaml
- Prtry:
- description: |
- Proprietary
-
- Name of the identification scheme, in a free text form.
- $ref: ./Max35Text.yaml
+ Specifies the type of the proxy account.
+type: object
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalProxyAccountType1Code.yaml
+ - description: >
+ Code
+
+ Proxy account type, in a coded form as published in an external list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Proprietary
+
+ Proxy account type, in a proprietary form.
+ required:
- Prtry
example:
- Cd: CH03
+ Cd: EMAIL
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml
index ae61d1ff..6b6c1f42 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml
@@ -1,5 +1,5 @@
title: Purpose2Choice
-description: >
+description: |
Specifies the underlying reason for the payment transaction.
Usage: Purpose is used by the end-customers, that is initiating party,
@@ -7,23 +7,26 @@ description: >
is a content element, which is not used for processing by any of the agents involved in the payment
chain.
type: object
-properties:
- Cd:
- description: |
- Code
-
- Underlying reason for the payment transaction, as published in an external purpose code list.
- $ref: ./ExternalPurpose1Code.yaml
- Prtry:
- description: |
- Proprietary
-
- Purpose, in a proprietary form.
- $ref: ./Max35Text.yaml
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalPurpose1Code.yaml
+ - description: |
+ Code
+
+ Underlying reason for the payment transaction, as published in an external purpose code list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ Proprietary
+
+ Purpose, in a proprietary form.
+ required:
- Prtry
example:
- Cd: CH03
+ Cd: CH03
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml
index ee22ba69..e0ebf3b5 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml
@@ -4,17 +4,19 @@ description: |
type: object
properties:
Nm:
- description: |
- Name
+ allOf:
+ - $ref: ./Max140Text.yaml
+ - description: |
+ Name
- Name of the entity requiring the regulatory reporting information.
- $ref: ./Max140Text.yaml
+ Name of the entity requiring the regulatory reporting information.
Ctry:
- description: |
- Country
+ allOf:
+ - $ref: ./CountryCode.yaml
+ - description: |
+ Country
- Country of the entity that requires the regulatory reporting information.
- $ref: ./CountryCode.yaml
+ Country of the entity that requires the regulatory reporting information.
example:
Nm: Swiss National Bank
- Ctry: CH
+ Ctry: CH
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml
index 77f999aa..9427db40 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml
@@ -4,18 +4,20 @@ description: |
type: object
properties:
DbtCdtRptgInd:
- description: >
- DebitCreditReportingIndicator
+ allOf:
+ - $ref: ./RegulatoryReportingType1Code.yaml
+ - description: >
+ DebitCreditReportingIndicator
- 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.
- $ref: ./RegulatoryReportingType1Code.yaml
+ 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.
Authrty:
- description: |
- Authority
+ allOf:
+ - $ref: ./RegulatoryAuthority2.yaml
+ - description: |
+ Authority
- Entity requiring the regulatory reporting information.
- $ref: ./RegulatoryAuthority2.yaml
+ Entity requiring the regulatory reporting information.
Dtls:
description: >
Details
@@ -34,4 +36,4 @@ example:
Ctry: CH
Dtls:
Cd: A1
- Inf: Mandatory regulatory information
+ Inf: Mandatory regulatory information
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml
index a12efbfb..61be8e44 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml
@@ -1,7 +1,11 @@
title: RegulatoryReportingType1Code
-description: >
+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.
+
+ CRED: Regulatory reporting applies to the credit side of the transaction.
+ DEBT: Regulatory reporting applies to the debit side of the transaction.
+ BOTH: Regulatory reporting applies to both debit and credit sides of the transaction.
type: string
enum:
- CRED
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml
index 6c3729cf..324a6336 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml
@@ -2,24 +2,27 @@ title: ServiceLevel8Choice
description: |
Details about a service level.
type: object
-properties:
- Cd:
- description: >
- Code
-
- Specifies a pre-agreed service or level of service between the parties,
- as published in an external service level code list.
- $ref: ./ExternalServiceLevel1Code.yaml
- Prtry:
- description: >
- Proprietary
-
- Specifies a pre-agreed service or level of service between the parties, as a proprietary code.
- $ref: ./Max35Text.yaml
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalServiceLevel1Code.yaml
+ - description: >
+ Code
+
+ Specifies a pre-agreed service or level of service between the parties,
+ as published in an external service level code list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Proprietary
+
+ Specifies a pre-agreed service or level of service between the parties, as a proprietary code.
+ required:
- Prtry
example:
- Cd: SEPA
+ Cd: SEPA
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml
index 5e092dcc..324fb3ad 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml
@@ -5,14 +5,8 @@ description: |
type: object
properties:
SttlmMtd:
- description: >
- SettlementMethod
-
- Method used to settle the (batch of) payment instructions.
$ref: ./SettlementMethod1Code.yaml
PmtTpInf:
- description: |
- PaymentTypeInformation
$ref: ./PaymentTypeInformation28.yaml
required:
- SttlmMtd
@@ -44,4 +38,4 @@ example:
CtctDtls:
Nm: Name
PhneNb: 123
- EmailAdr:
+ EmailAdr:
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml
index 9bdaadf2..4b2d541f 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml
@@ -1,10 +1,16 @@
title: SettlementMethod1Code
description: |
Specifies the method used to settle the credit transfer instruction.
+
+ INDA: Indirect Account
+ INGA: Indirect Agent
+ COVE: Cover
+ CLRG: Clearing
+
type: string
enum:
- INDA
- INGA
- COVE
- CLRG
-example: CLRG
+example: CLRG
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml
index 30da8712..def4cef0 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml
@@ -1,24 +1,27 @@
title: StatusReason6Choice
description: |
- Unsure on description.
+ Specifies the reason for the status.
type: object
-properties:
- Cd:
- description: >
- Code
-
- Reason for the status, as published in an external reason code list.
- $ref: ./ExternalStatusReason1Code.yaml
- Prtry:
- description: >
- Proprietary
-
- Reason for the status, in a proprietary form.
- $ref: ./Max35Text.yaml
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalStatusReason1Code.yaml
+ - description: >
+ Code
+
+ Reason for the status, as published in an external reason code list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Proprietary
+
+ Reason for the status, in a proprietary form.
+ required:
- Prtry
example:
- Cd: AGNT
+ Cd: AGNT
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml
index a87a29c8..76f425d5 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml
@@ -4,23 +4,26 @@ description: |
type: object
properties:
Orgtr:
- description:
- Originator
+ allOf:
+ - $ref: ./PartyIdentification272.yaml
+ - description: >
+ Originator
- Party that issues the status.
- $ref: ./PartyIdentification272.yaml
+ Party that issues the status.
Rsn:
- description:
- Reason
+ allOf:
+ - $ref: ./StatusReason6Choice.yaml
+ - description: >
+ Reason
- Specifies the reason for the status report.
- $ref: ./StatusReason6Choice.yaml
+ Specifies the reason for the status report.
AddtlInf:
- description:
- AdditionalInformation
+ allOf:
+ - $ref: ./Max105Text.yaml
+ - description: >
+ AdditionalInformation
- Additional information about the status report.
- $ref: ./Max105Text.yaml
+ Additional information about the status report.
example:
Orgtr:
Nm: Name
@@ -36,4 +39,4 @@ example:
Ctry: Country
Rsn:
Cd: AGNT
- AddtlInf: AdditionalInformation
+ AddtlInf: AdditionalInformation
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml
index 701bfc67..3e3ccc3c 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml
@@ -6,39 +6,45 @@ description: |
type: object
properties:
Tp:
- description: |
- Type
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ Type
- Specifies the type of the information supplied in the regulatory reporting details.
- $ref: ./Max35Text.yaml
+ Specifies the type of the information supplied in the regulatory reporting details.
Dt:
- description: |
- Date
+ allOf:
+ - $ref: ./ISODate.yaml
+ - description: |
+ Date
- Date related to the specified type of regulatory reporting details.
- $ref: ./ISODate.yaml
+ Date related to the specified type of regulatory reporting details.
Ctry:
- description: |
- Country
+ allOf:
+ - $ref: ./CountryCode.yaml
+ - description: |
+ Country
- Country related to the specified type of regulatory reporting details.
- $ref: ./CountryCode.yaml
+ Country related to the specified type of regulatory reporting details.
Cd:
- description: >
- Code
+ allOf:
+ - $ref: ./Max10Text.yaml
+ - description: >
+ Code
- Specifies the nature, purpose, and reason for the transaction to be reported
- for regulatory and statutory requirements in a coded form.
- $ref: ./Max10Text.yaml
+ Specifies the nature, purpose, and reason for the transaction to be reported
+ for regulatory and statutory requirements in a coded form.
Amt:
- description: |
- Amount
+ allOf:
+ - $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ - description: |
+ Amount
- Amount of money to be reported for regulatory and statutory requirements.
- $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ Amount of money to be reported for regulatory and statutory requirements.
Inf:
description: |
Information
+
Additional details that cater for specific domestic regulatory requirements.
anyOf:
- $ref: ./Max35Text.yaml
@@ -53,4 +59,4 @@ example:
Amt:
Ccy: CHF
Amt: 1000
- Inf: 12345
+ Inf: 12345
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml
index 0d9f9ad3..c10e6a77 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml
@@ -1,29 +1,31 @@
title: SupplementaryData1
description: >
- Additional information that can not be captured in the structured fields
+ Additional information that cannot be captured in the structured fields
and/or any other specific block.
type: object
properties:
PlcAndNm:
- description: >
- PlaceAndName
+ allOf:
+ - $ref: ./Max350Text.yaml
+ - description: >
+ PlaceAndName
- Unambiguous reference to the location where the supplementary data must be inserted in
- the message instance.
- $ref: ./Max350Text.yaml
+ Unambiguous reference to the location where the supplementary data must be inserted in
+ the message instance.
Envlp:
- description: >
- Envelope
+ allOf:
+ - $ref: ./SupplementaryDataEnvelope1.yaml
+ - description: >
+ Envelope
- Technical element wrapping the supplementary data.
+ Technical element wrapping the supplementary data.
- Technical component that contains the validated supplementary data information. This technical
- envelope allows to segregate the supplementary data information from any other information.
- $ref: ./SupplementaryDataEnvelope1.yaml
+ Technical component that contains the validated supplementary data information. This technical
+ envelope allows to segregate the supplementary data information from any other information.
required:
- Envlp
example:
PlcAndNm: Additional information
Envlp:
Cd: CH03
- Prtry: Additional information
+ Prtry: Additional information
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml
index 033db401..fa12816f 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml
@@ -4,23 +4,26 @@ description: |
type: object
properties:
Rate:
- description: |
- Rate
+ allOf:
+ - $ref: ./PercentageRate.yaml
+ - description: |
+ Rate
- Rate used to calculate the tax.
- $ref: ./PercentageRate.yaml
+ Rate used to calculate the tax.
TaxblBaseAmt:
- description: |
- TaxableBaseAmount
+ allOf:
+ - $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ - description: |
+ TaxableBaseAmount
- Amount of money on which the tax is based.
- $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ Amount of money on which the tax is based.
TtlAmt:
- description: |
- TotalAmount
+ allOf:
+ - $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ - description: |
+ TotalAmount
- Total amount that is the result of the calculation of the tax for the record.
- $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ Total amount that is the result of the calculation of the tax for the record.
Dtls:
description: |
Details
@@ -46,4 +49,4 @@ example:
Amt:
Ccy: CHF
Amt: 1000
- Inf: 12345
+ Inf: 12345
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml
index 48a86f81..fd0c8425 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml
@@ -4,17 +4,19 @@ description: |
type: object
properties:
Titl:
- description: |
- Title
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ Title
- Title or position of debtor or the debtor's authorised representative.
- $ref: ./Max35Text.yaml
+ Title or position of debtor or the debtor's authorised representative.
Nm:
- description: |
- Name
+ allOf:
+ - $ref: ./Max140Text.yaml
+ - description: |
+ Name
- Name of the debtor or the debtor's authorised representative.
- $ref: ./Max140Text.yaml
+ Name of the debtor or the debtor's authorised representative.
example:
Titl: Mr
Nm: John Doe
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml
index ae970db3..9cedeb2e 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml
@@ -5,65 +5,75 @@ description: >
type: object
properties:
Cdtr:
- description: |
- Creditor
+ allOf:
+ - $ref: ./TaxParty1.yaml
+ - description: |
+ Creditor
- Party on the credit side of the transaction to which the tax applies.
- $ref: ./TaxParty1.yaml
+ Party on the credit side of the transaction to which the tax applies.
Dbtr:
- description: |
- Debtor
+ allOf:
+ - $ref: ./TaxParty2.yaml
+ - description: |
+ Debtor
- Party on the debit side of the transaction to which the tax applies.
- $ref: ./TaxParty2.yaml
+ Party on the debit side of the transaction to which the tax applies.
UltmtDbtr:
- description: |
- UltimateDebtor
+ allOf:
+ - $ref: ./TaxParty2.yaml
+ - description: |
+ UltimateDebtor
- Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.
- $ref: ./TaxParty2.yaml
+ Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.
AdmstnZone:
- description: |
- AdministrationZone
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ AdministrationZone
- Territorial part of a country to which the tax payment is related.
- $ref: ./Max35Text.yaml
+ Territorial part of a country to which the tax payment is related.
RefNb:
- description: |
- ReferenceNumber
+ allOf:
+ - $ref: ./Max140Text.yaml
+ - description: |
+ ReferenceNumber
- Tax reference information that is specific to a taxing agency.
- $ref: ./Max140Text.yaml
+ Tax reference information that is specific to a taxing agency.
Mtd:
- description: |
- Method
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ Method
- Method used to indicate the underlying business or how the tax is paid.
- $ref: ./Max35Text.yaml
+ Method used to indicate the underlying business or how the tax is paid.
TtlTaxblBaseAmt:
- description: |
- TotalTaxableBaseAmount
+ allOf:
+ - $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ - description: |
+ TotalTaxableBaseAmount
- Total amount of money on which the tax is based.
- $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ Total amount of money on which the tax is based.
TtlTaxAmt:
- description: |
- TotalTaxAmount
+ allOf:
+ - $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ - description: |
+ TotalTaxAmount
- Total amount of money as result of the calculation of the tax.
- $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ Total amount of money as result of the calculation of the tax.
Dt:
- description: |
- Date
+ allOf:
+ - $ref: ./ISODate.yaml
+ - description: |
+ Date
- Date by which tax is due.
- $ref: ./ISODate.yaml
+ Date by which tax is due.
SeqNb:
- description: |
- SequenceNumber
+ allOf:
+ - $ref: ./Number.yaml
+ - description: |
+ SequenceNumber
- Sequential number of the tax report
- $ref: ./Number.yaml
+ Sequential number of the tax report.
Rcrd:
description: |
Record
@@ -102,4 +112,4 @@ example:
Amt:
Ccy: CHF
Amt: 1000
- Inf: 12345
+ Inf: 12345
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml
index ed6b458a..50b76cad 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml
@@ -4,24 +4,27 @@ description: |
type: object
properties:
TaxId:
- description: |
- TaxIdentification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ TaxIdentification
- Tax identification number of the creditor.
- $ref: ./Max35Text.yaml
+ Tax identification number of the creditor.
RegnId:
- description: |
- RegistrationIdentification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ RegistrationIdentification
- Unique identification, as assigned by an organisation, to unambiguously identify a party.
- $ref: ./Max35Text.yaml
+ Unique identification, as assigned by an organisation, to unambiguously identify a party.
TaxTp:
- description: |
- TaxType
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ TaxType
- Type of tax payer.
- $ref: ./Max35Text.yaml
+ Type of tax payer.
example:
TaxId: 123456789
RegnId: 123456789
- TaxTp: VAT
+ TaxTp: VAT
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml
index 8b3475b8..c3472d18 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml
@@ -4,33 +4,37 @@ description: |
type: object
properties:
TaxId:
- description: |
- TaxIdentification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ TaxIdentification
- Tax identification number of the debtor.
- $ref: ./Max35Text.yaml
+ Tax identification number of the debtor.
RegnId:
- description: |
- RegistrationIdentification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ RegistrationIdentification
- Unique identification, as assigned by an organisation, to unambiguously identify a party.
- $ref: ./Max35Text.yaml
+ Unique identification, as assigned by an organisation, to unambiguously identify a party.
TaxTp:
- description: |
- TaxType
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ TaxType
- Type of tax payer.
- $ref: ./Max35Text.yaml
+ Type of tax payer.
Authstn:
- description: |
- Authorisation
+ allOf:
+ - $ref: ./TaxAuthorisation1.yaml
+ - description: |
+ Authorisation
- Details of the authorised tax paying party.
- $ref: ./TaxAuthorisation1.yaml
+ Details of the authorised tax paying party.
example:
TaxId: 123456789
RegnId: 123456789
TaxTp: VAT
Authstn:
Titl: Mr
- Nm: John Doe
+ Nm: John Doe
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml
index b2dae5c3..860f211f 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml
@@ -4,26 +4,29 @@ description: |
type: object
properties:
FrToDt:
- $ref: ./DatePeriod2.yaml
- description: |
- FromToDate
+ allOf:
+ - $ref: ./DatePeriod2.yaml
+ - description: |
+ FromToDate
- Range of time between a start date and an end date for which the tax report is provided.
+ Range of time between a start date and an end date for which the tax report is provided.
Tp:
- $ref: ./TaxRecordPeriod1Code.yaml
- description: |
- Type
+ allOf:
+ - $ref: ./TaxRecordPeriod1Code.yaml
+ - description: |
+ Type
- Identification of the period related to the tax payment.
+ Identification of the period related to the tax payment.
Yr:
- $ref: ./ISOYear.yaml
- description: |
- Year
+ allOf:
+ - $ref: ./ISOYear.yaml
+ - description: |
+ Year
- Year related to the tax payment.
+ Year related to the tax payment.
example:
Yr: 2020
Tp: MM01
FrToDt:
FrDt: '2020-01-01'
- ToDt: '2020-01-31'
+ ToDt: '2020-01-31'
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml
index 055fea73..6b861ece 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml
@@ -4,59 +4,68 @@ description: |
type: object
properties:
AddtlInf:
- $ref: ./Max140Text.yaml
- description: |
- AdditionalInformation
+ allOf:
+ - $ref: ./Max140Text.yaml
+ - description: |
+ AdditionalInformation
- Further details of the tax record.
+ Further details of the tax record.
CertId:
- $ref: ./Max35Text.yaml
- description: |
- CertificateIdentification
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ CertificateIdentification
- Identification number of the tax report as assigned by the taxing authority.
+ Identification number of the tax report as assigned by the taxing authority.
Ctgy:
- $ref: ./Max35Text.yaml
- description: |
- Category
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ Category
- Specifies the tax code as published by the tax authority.
+ Specifies the tax code as published by the tax authority.
CtgyDtls:
- $ref: ./Max35Text.yaml
- description: |
- CategoryDetails
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ CategoryDetails
- Provides further details of the category tax code.
+ Provides further details of the category tax code.
DbtrSts:
- $ref: ./Max35Text.yaml
- description: |
- DebtorStatus
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ DebtorStatus
- Code provided by local authority to identify the status of the party that has drawn up the settlement document.
+ Code provided by local authority to identify the status of the party that has drawn up the settlement document.
FrmsCd:
- $ref: ./Max35Text.yaml
- description: |
- FormsCode
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ FormsCode
- Identifies, in a coded form, on which template the tax report is to be provided.
+ Identifies, in a coded form, on which template the tax report is to be provided.
Prd:
- $ref: ./TaxPeriod3.yaml
- description: |
- Period
+ allOf:
+ - $ref: ./TaxPeriod3.yaml
+ - description: |
+ Period
- Set of elements used to provide details on the period of time related to the tax payment.
+ Set of elements used to provide details on the period of time related to the tax payment.
TaxAmt:
- $ref: ./TaxAmount3.yaml
- description: |
- TaxAmount
+ allOf:
+ - $ref: ./TaxAmount3.yaml
+ - description: |
+ TaxAmount
- Set of elements used to provide information on the amount of the tax record.
+ Set of elements used to provide information on the amount of the tax record.
Tp:
- $ref: ./Max35Text.yaml
- description: |
- Type
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: |
+ Type
- High level code to identify the type of tax details.
+ High level code to identify the type of tax details.
example:
Tp: VAT
Ctgy: A
@@ -65,10 +74,17 @@ example:
CertId: 123456789
FrmsCd: 123456789
Prd:
- FrstDay: '2019-01-01'
- LastDay: '2019-12-31'
+ Yr: 2019
+ Tp: MM01
+ FrToDt:
+ FrDt: '2019-01-01'
+ ToDt: '2019-12-31'
TaxAmt:
Rate: 0.2
- TaxblBaseAmt: 1000
- TtlAmt: 200
- AddtlInf: VAT applicable
+ TaxblBaseAmt:
+ Ccy: EUR
+ Amt: 1000
+ TtlAmt:
+ Ccy: EUR
+ Amt: 200
+ AddtlInf: VAT applicable
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml
index 5f042d78..e0a2ae54 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml
@@ -1,20 +1,22 @@
title: TaxRecordDetails3
description: |
- Details on the tax period and amount
+ Details on the tax period and amount.
type: object
properties:
Prd:
- description: |
- Period
+ allOf:
+ - $ref: ./TaxPeriod3.yaml
+ - description: |
+ Period
- Set of elements used to provide details on the period of time related to the tax payment.
- $ref: ./TaxPeriod3.yaml
+ Set of elements used to provide details on the period of time related to the tax payment.
Amt:
- description: |
- Amount
+ allOf:
+ - $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ - description: |
+ Amount
- Underlying tax amount related to the specified period.
- $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+ Underlying tax amount related to the specified period.
required:
- Amt
example:
@@ -26,4 +28,4 @@ example:
ToDt: '2020-01-31'
Amt:
Amt: 100.00
- Ccy: EUR
+ Ccy: EUR
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml
index ea1cf56d..eabd691f 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml
@@ -25,7 +25,7 @@ enum:
- MM01
- MM02
- MM03
- - MM04
+ - MM04
- MM05
- MM06
- MM07
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml
index a7234324..35fe94f6 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml
@@ -1,8 +1,16 @@
title: TermsRequest_FIToFICustomerCreditProposal
type: object
+description: >
+ This message is sent by a financial institution to a financial institution
+ to propose the terms of a credit to a customer.
properties:
GrpHdr:
- $ref: ./GroupHeader129.yaml
+ allOf:
+ - $ref: ./GroupHeader129.yaml
+ - description: >
+ Group Header
+
+ Set of characteristics shared by all individual transactions included in the message.
required:
- GrpHdr
example:
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml
index 0b7f7718..cdbf7067 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml
@@ -1,10 +1,22 @@
title: TermsResponse_FIToFICustomerCreditConfirmation
type: object
+description: >
+ This message is sent by the initiating party to the executing party, directly or through one or more intermediaries, to confirm the credit transfer transaction.
properties:
GrpHdr:
- $ref: ./GroupHeader129.yaml
+ allOf:
+ - $ref: ./GroupHeader129.yaml
+ - description: >
+ Group Header
+
+ Set of characteristics shared by all individual transactions included in the message.
CdtTrfTxInf:
- $ref: ./CreditTransferTransaction67.yaml
+ allOf:
+ - $ref: ./CreditTransferTransaction67.yaml
+ - description: >
+ Credit Transfer Transaction Information
+
+ Set of elements providing information specific to the individual credit transfer(s).
required:
- GrpHdr
- CdtTrfTxInf
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml
index 057f46df..bf7fc4fa 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml
@@ -1,23 +1,29 @@
title: VerificationReason1Choice
type: object
-properties:
- Cd:
- description: >
- Code
-
- Reason why the verified identification information is incorrect, as published in an external
- reason code list.
- $ref: ./ExternalVerificationReason1Code.yaml
- Prtry:
- description: >
- Proprietary
-
- Reason why the verified identification information is incorrect, in a free text form.
- $ref: ./Max35Text.yaml
+description: |
+ Choice of format for the verification reason.
+ Only one, between the coded and the proprietary, can be chosen.
oneOf:
- - required:
+ - properties:
+ Cd:
+ allOf:
+ - $ref: ./ExternalVerificationReason1Code.yaml
+ - description: >
+ Code
+
+ Reason why the verified identification information is incorrect, as published in an external
+ reason code list.
+ required:
- Cd
- - required:
+ - properties:
+ Prtry:
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ Proprietary
+
+ Reason why the verified identification information is incorrect, in a free text form.
+ required:
- Prtry
example:
- Cd: AGNT
+ Cd: AGNT
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml
index 1ae4bf0c..51a33958 100644
--- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml
@@ -1,41 +1,51 @@
title: VerificationReport4
type: object
+description:
+ VerificationReport
+
+ Provides information about the verification of party and/or account identification information.
properties:
- OrgnlId:
- description: >
- OriginalIdentification
+ OrgnlId:
+ allOf:
+ - $ref: ./Max35Text.yaml
+ - description: >
+ OriginalIdentification
- Unique identification, as assigned by a sending party, to unambiguously identify the party
- and account identification information group within the original message.
- $ref: ./Max35Text.yaml
+ Unique identification, as assigned by a sending party, to unambiguously identify the party
+ and account identification information group within the original message.
Vrfctn:
- description: >
- Verification
+ allOf:
+ - $ref: ./IdentificationVerificationIndicator.yaml
+ - description: >
+ Verification
- Identifies whether the party and/or account information received is correct.
- Boolean value.
- $ref: ./IdentificationVerificationIndicator.yaml
+ Identifies whether the party and/or account information received is correct.
+ Boolean value.
Rsn:
- description: >
- Reason.
+ allOf:
+ - $ref: ./VerificationReason1Choice.yaml
+ - description: >
+ Reason
- Specifies the reason why the verified identification information is incorrect.
- $ref: ./VerificationReason1Choice.yaml
+ Specifies the reason why the verified identification information is incorrect.
OrgnlPtyAndAcctId:
- description: >
- OriginalPartyAndAccountIdentification
+ allOf:
+ - $ref: ./IdentificationInformation4.yaml
+ - description: >
+ OriginalPartyAndAccountIdentification
- Provides party and/or account identification information as given in the original message.
- $ref: ./IdentificationInformation4.yaml
+ Provides party and/or account identification information as given in the original message.
UpdtdPtyAndAcctId:
- description: >
- UpdatedPartyAndAccountIdentification
+ allOf:
+ - $ref: ./IdentificationInformation4.yaml
+ - description: >
+ UpdatedPartyAndAccountIdentification
- Provides party and/or account identification information.
- $ref: ./IdentificationInformation4.yaml
+ Provides party and/or account identification information.
required:
- OrgnlId
- Vrfctn
+ - UpdtdPtyAndAcctId
example:
OrgnlId: 1234567890123456789012345678901234
Vrfctn: true
@@ -74,4 +84,4 @@ example:
AnyBIC: ABCDUS33
Othr:
Id: 123456789
- Issr: ABA
+ Issr: ABA
\ No newline at end of file
diff --git a/fspiop/v2_0_ISO20022/openapi3/openapi.yaml b/fspiop/v2_0_ISO20022/openapi3/openapi.yaml
index 0e2fbc03..825f33ce 100644
--- a/fspiop/v2_0_ISO20022/openapi3/openapi.yaml
+++ b/fspiop/v2_0_ISO20022/openapi3/openapi.yaml
@@ -1,4 +1,4 @@
-openapi: 3.1.0
+openapi: 3.0.2
info:
version: v2.0-iso20022-draft
title: Open API for FSP Interoperability (FSPIOP) - the ISO 20022 message version
diff --git a/package-lock.json b/package-lock.json
index ad6c30f6..2063e853 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -16,7 +16,7 @@
"js-yaml": "^4.1.0",
"json-refs": "^3.0.15",
"openapi-types": "^12.1.3",
- "openapi-typescript": "^7.4.0",
+ "openapi-typescript": "^7.4.1",
"ts-auto-mock": "^3.7.4"
},
"devDependencies": {
@@ -24,12 +24,12 @@
"@commitlint/config-conventional": "^19.5.0",
"@redocly/cli": "^1.5.0",
"@redocly/openapi-cli": "^1.0.0-beta.95",
- "@types/jest": "^29.5.12",
+ "@types/jest": "^29.5.13",
"@types/js-yaml": "^4.0.9",
- "@typescript-eslint/eslint-plugin": "^8.5.0",
- "@typescript-eslint/parser": "^8.5.0",
+ "@typescript-eslint/eslint-plugin": "^8.7.0",
+ "@typescript-eslint/parser": "^8.7.0",
"audit-ci": "^7.1.0",
- "browser-sync": "^3.0.2",
+ "browser-sync": "^3.0.3",
"diff": "^7.0.0",
"eslint": "^8.55.0",
"eslint-config-prettier": "^9.1.0",
@@ -41,11 +41,11 @@
"eslint-plugin-prettier": "^5.2.1",
"eslint-plugin-promise": "^6.2.0",
"eslint-plugin-standard": "^5.0.0",
- "husky": "9.1.5",
+ "husky": "9.1.6",
"jest": "^29.7.0",
"jest-junit": "^16.0.0",
"lint-staged": "^15.2.10",
- "npm-check-updates": "^17.1.1",
+ "npm-check-updates": "^17.1.3",
"prettier": "^3.3.3",
"standard-version": "^9.5.0",
"swagger-cli": "^4.0.4",
@@ -2189,14 +2189,14 @@
}
},
"node_modules/@redocly/ajv": {
- "version": "8.11.0",
- "resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.11.0.tgz",
- "integrity": "sha512-9GWx27t7xWhDIR02PA18nzBdLcKQRgc46xNQvjFkrYk4UOmvKhJ/dawwiX0cCOeetN5LcaaiqQbVOWYK62SGHw==",
+ "version": "8.11.2",
+ "resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.11.2.tgz",
+ "integrity": "sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==",
"dependencies": {
"fast-deep-equal": "^3.1.1",
"json-schema-traverse": "^1.0.0",
"require-from-string": "^2.0.2",
- "uri-js": "^4.2.2"
+ "uri-js-replace": "^1.0.1"
},
"funding": {
"type": "github",
@@ -2283,9 +2283,9 @@
}
},
"node_modules/@redocly/config": {
- "version": "0.10.1",
- "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.10.1.tgz",
- "integrity": "sha512-H3LnKVGzOaxskwJu8pmJYwBOWjP61qOK7TuTrbafqArDVckE06fhA6l0nO4KvBbjLPjy1Al7UnlxOu23V4Nl0w=="
+ "version": "0.11.0",
+ "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.11.0.tgz",
+ "integrity": "sha512-vAc77vCuWsVgLx2LN02P6jqLBhHuot6O1LsSJEAAkWEvXARSGSQVon50QW7jlbCMg9OFTYYYRPN4W6K/YmnM3w=="
},
"node_modules/@redocly/openapi-cli": {
"version": "1.0.0-beta.95",
@@ -2601,9 +2601,9 @@
}
},
"node_modules/@types/jest": {
- "version": "29.5.12",
- "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.12.tgz",
- "integrity": "sha512-eDC8bTvT/QhYdxJAulQikueigY5AsdBRH2yDKW3yveW7svY3+DzN84/2NUgkw10RTiJbWqZrTtoGVdYlvFJdLw==",
+ "version": "29.5.13",
+ "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.13.tgz",
+ "integrity": "sha512-wd+MVEZCHt23V0/L642O5APvspWply/rGY5BcW4SUETo2UzPU3Z26qr8jC2qxpimI2jjx9h7+2cj2FwIr01bXg==",
"dev": true,
"dependencies": {
"expect": "^29.0.0",
@@ -2679,16 +2679,16 @@
"dev": true
},
"node_modules/@typescript-eslint/eslint-plugin": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.5.0.tgz",
- "integrity": "sha512-lHS5hvz33iUFQKuPFGheAB84LwcJ60G8vKnEhnfcK1l8kGVLro2SFYW6K0/tj8FUhRJ0VHyg1oAfg50QGbPPHw==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.7.0.tgz",
+ "integrity": "sha512-RIHOoznhA3CCfSTFiB6kBGLQtB/sox+pJ6jeFu6FxJvqL8qRxq/FfGO/UhsGgQM9oGdXkV4xUgli+dt26biB6A==",
"dev": true,
"dependencies": {
"@eslint-community/regexpp": "^4.10.0",
- "@typescript-eslint/scope-manager": "8.5.0",
- "@typescript-eslint/type-utils": "8.5.0",
- "@typescript-eslint/utils": "8.5.0",
- "@typescript-eslint/visitor-keys": "8.5.0",
+ "@typescript-eslint/scope-manager": "8.7.0",
+ "@typescript-eslint/type-utils": "8.7.0",
+ "@typescript-eslint/utils": "8.7.0",
+ "@typescript-eslint/visitor-keys": "8.7.0",
"graphemer": "^1.4.0",
"ignore": "^5.3.1",
"natural-compare": "^1.4.0",
@@ -2712,15 +2712,15 @@
}
},
"node_modules/@typescript-eslint/parser": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.5.0.tgz",
- "integrity": "sha512-gF77eNv0Xz2UJg/NbpWJ0kqAm35UMsvZf1GHj8D9MRFTj/V3tAciIWXfmPLsAAF/vUlpWPvUDyH1jjsr0cMVWw==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.7.0.tgz",
+ "integrity": "sha512-lN0btVpj2unxHlNYLI//BQ7nzbMJYBVQX5+pbNXvGYazdlgYonMn4AhhHifQ+J4fGRYA/m1DjaQjx+fDetqBOQ==",
"dev": true,
"dependencies": {
- "@typescript-eslint/scope-manager": "8.5.0",
- "@typescript-eslint/types": "8.5.0",
- "@typescript-eslint/typescript-estree": "8.5.0",
- "@typescript-eslint/visitor-keys": "8.5.0",
+ "@typescript-eslint/scope-manager": "8.7.0",
+ "@typescript-eslint/types": "8.7.0",
+ "@typescript-eslint/typescript-estree": "8.7.0",
+ "@typescript-eslint/visitor-keys": "8.7.0",
"debug": "^4.3.4"
},
"engines": {
@@ -2740,13 +2740,13 @@
}
},
"node_modules/@typescript-eslint/scope-manager": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.5.0.tgz",
- "integrity": "sha512-06JOQ9Qgj33yvBEx6tpC8ecP9o860rsR22hWMEd12WcTRrfaFgHr2RB/CA/B+7BMhHkXT4chg2MyboGdFGawYg==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.7.0.tgz",
+ "integrity": "sha512-87rC0k3ZlDOuz82zzXRtQ7Akv3GKhHs0ti4YcbAJtaomllXoSO8hi7Ix3ccEvCd824dy9aIX+j3d2UMAfCtVpg==",
"dev": true,
"dependencies": {
- "@typescript-eslint/types": "8.5.0",
- "@typescript-eslint/visitor-keys": "8.5.0"
+ "@typescript-eslint/types": "8.7.0",
+ "@typescript-eslint/visitor-keys": "8.7.0"
},
"engines": {
"node": "^18.18.0 || ^20.9.0 || >=21.1.0"
@@ -2757,13 +2757,13 @@
}
},
"node_modules/@typescript-eslint/type-utils": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.5.0.tgz",
- "integrity": "sha512-N1K8Ix+lUM+cIDhL2uekVn/ZD7TZW+9/rwz8DclQpcQ9rk4sIL5CAlBC0CugWKREmDjBzI/kQqU4wkg46jWLYA==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.7.0.tgz",
+ "integrity": "sha512-tl0N0Mj3hMSkEYhLkjREp54OSb/FI6qyCzfiiclvJvOqre6hsZTGSnHtmFLDU8TIM62G7ygEa1bI08lcuRwEnQ==",
"dev": true,
"dependencies": {
- "@typescript-eslint/typescript-estree": "8.5.0",
- "@typescript-eslint/utils": "8.5.0",
+ "@typescript-eslint/typescript-estree": "8.7.0",
+ "@typescript-eslint/utils": "8.7.0",
"debug": "^4.3.4",
"ts-api-utils": "^1.3.0"
},
@@ -2781,9 +2781,9 @@
}
},
"node_modules/@typescript-eslint/types": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.5.0.tgz",
- "integrity": "sha512-qjkormnQS5wF9pjSi6q60bKUHH44j2APxfh9TQRXK8wbYVeDYYdYJGIROL87LGZZ2gz3Rbmjc736qyL8deVtdw==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.7.0.tgz",
+ "integrity": "sha512-LLt4BLHFwSfASHSF2K29SZ+ZCsbQOM+LuarPjRUuHm+Qd09hSe3GCeaQbcCr+Mik+0QFRmep/FyZBO6fJ64U3w==",
"dev": true,
"engines": {
"node": "^18.18.0 || ^20.9.0 || >=21.1.0"
@@ -2794,13 +2794,13 @@
}
},
"node_modules/@typescript-eslint/typescript-estree": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.5.0.tgz",
- "integrity": "sha512-vEG2Sf9P8BPQ+d0pxdfndw3xIXaoSjliG0/Ejk7UggByZPKXmJmw3GW5jV2gHNQNawBUyfahoSiCFVov0Ruf7Q==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.7.0.tgz",
+ "integrity": "sha512-MC8nmcGHsmfAKxwnluTQpNqceniT8SteVwd2voYlmiSWGOtjvGXdPl17dYu2797GVscK30Z04WRM28CrKS9WOg==",
"dev": true,
"dependencies": {
- "@typescript-eslint/types": "8.5.0",
- "@typescript-eslint/visitor-keys": "8.5.0",
+ "@typescript-eslint/types": "8.7.0",
+ "@typescript-eslint/visitor-keys": "8.7.0",
"debug": "^4.3.4",
"fast-glob": "^3.3.2",
"is-glob": "^4.0.3",
@@ -2846,15 +2846,15 @@
}
},
"node_modules/@typescript-eslint/utils": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.5.0.tgz",
- "integrity": "sha512-6yyGYVL0e+VzGYp60wvkBHiqDWOpT63pdMV2CVG4LVDd5uR6q1qQN/7LafBZtAtNIn/mqXjsSeS5ggv/P0iECw==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.7.0.tgz",
+ "integrity": "sha512-ZbdUdwsl2X/s3CiyAu3gOlfQzpbuG3nTWKPoIvAu1pu5r8viiJvv2NPN2AqArL35NCYtw/lrPPfM4gxrMLNLPw==",
"dev": true,
"dependencies": {
"@eslint-community/eslint-utils": "^4.4.0",
- "@typescript-eslint/scope-manager": "8.5.0",
- "@typescript-eslint/types": "8.5.0",
- "@typescript-eslint/typescript-estree": "8.5.0"
+ "@typescript-eslint/scope-manager": "8.7.0",
+ "@typescript-eslint/types": "8.7.0",
+ "@typescript-eslint/typescript-estree": "8.7.0"
},
"engines": {
"node": "^18.18.0 || ^20.9.0 || >=21.1.0"
@@ -2868,12 +2868,12 @@
}
},
"node_modules/@typescript-eslint/visitor-keys": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.5.0.tgz",
- "integrity": "sha512-yTPqMnbAZJNy2Xq2XU8AdtOW9tJIr+UQb64aXB9f3B1498Zx9JorVgFJcZpEc9UBuCCrdzKID2RGAMkYcDtZOw==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.7.0.tgz",
+ "integrity": "sha512-b1tx0orFCCh/THWPQa2ZwWzvOeyzzp36vkJYOpVg0u8UVOIsfVrnuC9FqAw9gRKn+rG2VmWQ/zDJZzkxUnj/XQ==",
"dev": true,
"dependencies": {
- "@typescript-eslint/types": "8.5.0",
+ "@typescript-eslint/types": "8.7.0",
"eslint-visitor-keys": "^3.4.3"
},
"engines": {
@@ -3403,13 +3403,13 @@
}
},
"node_modules/browser-sync": {
- "version": "3.0.2",
- "resolved": "https://registry.npmjs.org/browser-sync/-/browser-sync-3.0.2.tgz",
- "integrity": "sha512-PC9c7aWJFVR4IFySrJxOqLwB9ENn3/TaXCXtAa0SzLwocLN3qMjN+IatbjvtCX92BjNXsY6YWg9Eb7F3Wy255g==",
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/browser-sync/-/browser-sync-3.0.3.tgz",
+ "integrity": "sha512-91hoBHKk1C4pGeD+oE9Ld222k2GNQEAsI5AElqR8iLLWNrmZR2LPP8B0h8dpld9u7kro5IEUB3pUb0DJ3n1cRQ==",
"dev": true,
"dependencies": {
- "browser-sync-client": "^3.0.2",
- "browser-sync-ui": "^3.0.2",
+ "browser-sync-client": "^3.0.3",
+ "browser-sync-ui": "^3.0.3",
"bs-recipes": "1.3.4",
"chalk": "4.1.2",
"chokidar": "^3.5.1",
@@ -3423,15 +3423,15 @@
"fs-extra": "3.0.1",
"http-proxy": "^1.18.1",
"immutable": "^3",
- "micromatch": "^4.0.2",
+ "micromatch": "^4.0.8",
"opn": "5.3.0",
"portscanner": "2.2.0",
"raw-body": "^2.3.2",
"resp-modifier": "6.0.2",
"rx": "4.1.0",
- "send": "0.16.2",
- "serve-index": "1.9.1",
- "serve-static": "1.13.2",
+ "send": "^0.19.0",
+ "serve-index": "^1.9.1",
+ "serve-static": "^1.16.2",
"server-destroy": "1.0.1",
"socket.io": "^4.4.1",
"ua-parser-js": "^1.0.33",
@@ -3445,9 +3445,9 @@
}
},
"node_modules/browser-sync-client": {
- "version": "3.0.2",
- "resolved": "https://registry.npmjs.org/browser-sync-client/-/browser-sync-client-3.0.2.tgz",
- "integrity": "sha512-tBWdfn9L0wd2Pjuz/NWHtNEKthVb1Y67vg8/qyGNtCqetNz5lkDkFnrsx5UhPNPYUO8vci50IWC/BhYaQskDiQ==",
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/browser-sync-client/-/browser-sync-client-3.0.3.tgz",
+ "integrity": "sha512-TOEXaMgYNjBYIcmX5zDlOdjEqCeCN/d7opf/fuyUD/hhGVCfP54iQIDhENCi012AqzYZm3BvuFl57vbwSTwkSQ==",
"dev": true,
"dependencies": {
"etag": "1.8.1",
@@ -3459,9 +3459,9 @@
}
},
"node_modules/browser-sync-ui": {
- "version": "3.0.2",
- "resolved": "https://registry.npmjs.org/browser-sync-ui/-/browser-sync-ui-3.0.2.tgz",
- "integrity": "sha512-V3FwWAI+abVbFLTyJjXJlCMBwjc3GXf/BPGfwO2fMFACWbIGW9/4SrBOFYEOOtqzCjQE0Di+U3VIb7eES4omNA==",
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/browser-sync-ui/-/browser-sync-ui-3.0.3.tgz",
+ "integrity": "sha512-FcGWo5lP5VodPY6O/f4pXQy5FFh4JK0f2/fTBsp0Lx1NtyBWs/IfPPJbW8m1ujTW/2r07oUXKTF2LYZlCZktjw==",
"dev": true,
"dependencies": {
"async-each-series": "0.1.1",
@@ -4720,10 +4720,14 @@
}
},
"node_modules/destroy": {
- "version": "1.0.4",
- "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.0.4.tgz",
- "integrity": "sha512-3NdhDuEXnfun/z7x9GOElY49LoqVHoGScmOKwmxhsS8N5Y+Z8KyPPDnaSzqWgYt/ji4mqwfTS34Htrk0zPIXVg==",
- "dev": true
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz",
+ "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==",
+ "dev": true,
+ "engines": {
+ "node": ">= 0.8",
+ "npm": "1.2.8000 || >= 1.4.16"
+ }
},
"node_modules/detect-indent": {
"version": "6.1.0",
@@ -4786,9 +4790,9 @@
}
},
"node_modules/dompurify": {
- "version": "2.4.7",
- "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-2.4.7.tgz",
- "integrity": "sha512-kxxKlPEDa6Nc5WJi+qRgPbOAbgTpSULL+vI3NUXsZMlkJxTqYI9wg5ZTay2sFrdZRWHPWNi+EdAhcJf81WtoMQ==",
+ "version": "2.5.6",
+ "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-2.5.6.tgz",
+ "integrity": "sha512-zUTaUBO8pY4+iJMPE1B9XlO2tXVYIcEA4SNGtvDELzTSCQO7RzH+j7S180BmhmJId78lqGU2z19vgVx2Sxs/PQ==",
"dev": true
},
"node_modules/dot-prop": {
@@ -4993,16 +4997,16 @@
}
},
"node_modules/engine.io-client": {
- "version": "6.5.4",
- "resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-6.5.4.tgz",
- "integrity": "sha512-GeZeeRjpD2qf49cZQ0Wvh/8NJNfeXkXXcoGh+F77oEAgo9gUHwT1fCRxSNU+YEEaysOJTnsFHmM5oAcPy4ntvQ==",
+ "version": "6.6.1",
+ "resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-6.6.1.tgz",
+ "integrity": "sha512-aYuoak7I+R83M/BBPIOs2to51BmFIpC1wZe6zZzMrT2llVsHy5cvcmdsJgP2Qz6smHu+sD9oexiSUAVd8OfBPw==",
"dev": true,
"dependencies": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.3.1",
"engine.io-parser": "~5.2.1",
"ws": "~8.17.1",
- "xmlhttprequest-ssl": "~2.0.0"
+ "xmlhttprequest-ssl": "~2.1.1"
}
},
"node_modules/engine.io-client/node_modules/ws": {
@@ -6941,9 +6945,9 @@
}
},
"node_modules/husky": {
- "version": "9.1.5",
- "resolved": "https://registry.npmjs.org/husky/-/husky-9.1.5.tgz",
- "integrity": "sha512-rowAVRUBfI0b4+niA4SJMhfQwc107VLkBUgEYYAOQAbqDCnra1nYh83hF/MDmhYs9t9n1E3DuKOrs2LYNC+0Ag==",
+ "version": "9.1.6",
+ "resolved": "https://registry.npmjs.org/husky/-/husky-9.1.6.tgz",
+ "integrity": "sha512-sqbjZKK7kf44hfdE94EoX8MZNk0n7HeW37O4YrVGCF4wzgQjp+akPAkfUK5LZ6KuR/6sqeAVuXHji+RzQgOn5A==",
"dev": true,
"bin": {
"husky": "bin.js"
@@ -9090,12 +9094,14 @@
}
},
"node_modules/mime": {
- "version": "1.4.1",
- "resolved": "https://registry.npmjs.org/mime/-/mime-1.4.1.tgz",
- "integrity": "sha512-KI1+qOZu5DcW6wayYHSzR/tXKCDC5Om4s1z2QJjDULzLcmf3DvzS7oluY4HCTrc+9FiKmWUgeNLg7W3uIQvxtQ==",
- "dev": true,
+ "version": "1.6.0",
+ "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz",
+ "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==",
"bin": {
"mime": "cli.js"
+ },
+ "engines": {
+ "node": ">=4"
}
},
"node_modules/mime-db": {
@@ -9392,9 +9398,9 @@
}
},
"node_modules/npm-check-updates": {
- "version": "17.1.1",
- "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-17.1.1.tgz",
- "integrity": "sha512-2aqIzGAEWB7xPf0hKHTkNmUM5jHbn2S5r2/z/7dA5Ij2h/sVYAg9R/uVkaUC3VORPAfBm7pKkCWo6E9clEVQ9A==",
+ "version": "17.1.3",
+ "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-17.1.3.tgz",
+ "integrity": "sha512-4uDLBWPuDHT5KLieIJ20FoAB8yqJejmupI42wPyfObgQOBbPAikQSwT73afDwREvhuxYrRDqlRvxTMSfvO+L8A==",
"dev": true,
"bin": {
"ncu": "build/cli.js",
@@ -9659,11 +9665,11 @@
"integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw=="
},
"node_modules/openapi-typescript": {
- "version": "7.4.0",
- "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-7.4.0.tgz",
- "integrity": "sha512-u4iVuTGkzKG4rHFUMA/IFXTks9tYVQzkowZsScMOdzJSvIF10qSNySWHTwnN2fD+MEeWFAM8i1f3IUBlgS92eQ==",
+ "version": "7.4.1",
+ "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-7.4.1.tgz",
+ "integrity": "sha512-HrRoWveViADezHCNgQqZmPKmQ74q7nuH/yg9ursFucZaYQNUqsX38fE/V2sKBHVM+pws4tAHpuh/ext2UJ/AoQ==",
"dependencies": {
- "@redocly/openapi-core": "^1.16.0",
+ "@redocly/openapi-core": "^1.25.3",
"ansi-colors": "^4.1.3",
"change-case": "^5.4.4",
"parse-json": "^8.1.0",
@@ -9678,12 +9684,12 @@
}
},
"node_modules/openapi-typescript/node_modules/@redocly/openapi-core": {
- "version": "1.22.1",
- "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.22.1.tgz",
- "integrity": "sha512-pjr456gJzrbwPvBjFKlWOd9nZEcr/dp6XSH0c8ijWGWv5K+V0vpUUy2zaTAVsFAoCydx1miEoOcbLhWQ9WC2nw==",
+ "version": "1.25.3",
+ "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.25.3.tgz",
+ "integrity": "sha512-dqJkyydgagW3FXX5cjtSUAnabsld4K6yq7RFgQ+ngI1m43PkEoSQt8pp+SfQDszSEoMbc7QKj8afbe7mZw17TA==",
"dependencies": {
- "@redocly/ajv": "^8.11.0",
- "@redocly/config": "^0.10.1",
+ "@redocly/ajv": "^8.11.2",
+ "@redocly/config": "^0.11.0",
"colorette": "^1.2.0",
"https-proxy-agent": "^7.0.4",
"js-levenshtein": "^1.1.6",
@@ -10996,24 +11002,24 @@
}
},
"node_modules/send": {
- "version": "0.16.2",
- "resolved": "https://registry.npmjs.org/send/-/send-0.16.2.tgz",
- "integrity": "sha512-E64YFPUssFHEFBvpbbjr44NCLtI1AohxQ8ZSiJjQLskAdKuriYEP6VyGEsRDH8ScozGpkaX1BGvhanqCwkcEZw==",
+ "version": "0.19.0",
+ "resolved": "https://registry.npmjs.org/send/-/send-0.19.0.tgz",
+ "integrity": "sha512-dW41u5VfLXu8SJh5bwRmyYUbAoSB3c9uQh6L8h/KtsFREPWpbX1lrljJo186Jc4nmci/sGUZ9a0a0J2zgfq2hw==",
"dev": true,
"dependencies": {
"debug": "2.6.9",
- "depd": "~1.1.2",
- "destroy": "~1.0.4",
+ "depd": "2.0.0",
+ "destroy": "1.2.0",
"encodeurl": "~1.0.2",
"escape-html": "~1.0.3",
"etag": "~1.8.1",
"fresh": "0.5.2",
- "http-errors": "~1.6.2",
- "mime": "1.4.1",
- "ms": "2.0.0",
- "on-finished": "~2.3.0",
- "range-parser": "~1.2.0",
- "statuses": "~1.4.0"
+ "http-errors": "2.0.0",
+ "mime": "1.6.0",
+ "ms": "2.1.3",
+ "on-finished": "2.4.1",
+ "range-parser": "~1.2.1",
+ "statuses": "2.0.1"
},
"engines": {
"node": ">= 0.8.0"
@@ -11028,55 +11034,31 @@
"ms": "2.0.0"
}
},
- "node_modules/send/node_modules/depd": {
- "version": "1.1.2",
- "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz",
- "integrity": "sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ==",
- "dev": true,
- "engines": {
- "node": ">= 0.6"
- }
+ "node_modules/send/node_modules/debug/node_modules/ms": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+ "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==",
+ "dev": true
},
- "node_modules/send/node_modules/http-errors": {
- "version": "1.6.3",
- "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.6.3.tgz",
- "integrity": "sha512-lks+lVC8dgGyh97jxvxeYTWQFvh4uw4yC12gVl63Cg30sjPX4wuGcdkICVXDAESr6OJGjqGA8Iz5mkeN6zlD7A==",
+ "node_modules/send/node_modules/on-finished": {
+ "version": "2.4.1",
+ "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz",
+ "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==",
"dev": true,
"dependencies": {
- "depd": "~1.1.2",
- "inherits": "2.0.3",
- "setprototypeof": "1.1.0",
- "statuses": ">= 1.4.0 < 2"
+ "ee-first": "1.1.1"
},
"engines": {
- "node": ">= 0.6"
+ "node": ">= 0.8"
}
},
- "node_modules/send/node_modules/inherits": {
- "version": "2.0.3",
- "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz",
- "integrity": "sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw==",
- "dev": true
- },
- "node_modules/send/node_modules/ms": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
- "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==",
- "dev": true
- },
- "node_modules/send/node_modules/setprototypeof": {
- "version": "1.1.0",
- "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.0.tgz",
- "integrity": "sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ==",
- "dev": true
- },
"node_modules/send/node_modules/statuses": {
- "version": "1.4.0",
- "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.4.0.tgz",
- "integrity": "sha512-zhSCtt8v2NDrRlPQpCNtw/heZLtfUDqxBM1udqikb/Hbk52LK4nQSwr10u77iopCW5LsyHpuXS0GnEc48mLeew==",
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz",
+ "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==",
"dev": true,
"engines": {
- "node": ">= 0.6"
+ "node": ">= 0.8"
}
},
"node_modules/serve-index": {
@@ -11158,20 +11140,29 @@
}
},
"node_modules/serve-static": {
- "version": "1.13.2",
- "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.13.2.tgz",
- "integrity": "sha512-p/tdJrO4U387R9oMjb1oj7qSMaMfmOyd4j9hOFoxZe2baQszgHcSWjuya/CiT5kgZZKRudHNOA0pYXOl8rQ5nw==",
+ "version": "1.16.2",
+ "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.16.2.tgz",
+ "integrity": "sha512-VqpjJZKadQB/PEbEwvFdO43Ax5dFBZ2UECszz8bQ7pi7wt//PWe1P6MN7eCnjsatYtBT6EuiClbjSWP2WrIoTw==",
"dev": true,
"dependencies": {
- "encodeurl": "~1.0.2",
+ "encodeurl": "~2.0.0",
"escape-html": "~1.0.3",
- "parseurl": "~1.3.2",
- "send": "0.16.2"
+ "parseurl": "~1.3.3",
+ "send": "0.19.0"
},
"engines": {
"node": ">= 0.8.0"
}
},
+ "node_modules/serve-static/node_modules/encodeurl": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz",
+ "integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==",
+ "dev": true,
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
"node_modules/server-destroy": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/server-destroy/-/server-destroy-1.0.1.tgz",
@@ -11449,14 +11440,14 @@
}
},
"node_modules/socket.io-client": {
- "version": "4.7.5",
- "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.7.5.tgz",
- "integrity": "sha512-sJ/tqHOCe7Z50JCBCXrsY3I2k03iOiUe+tj1OmKeD2lXPiGH/RUCdTZFoqVyN7l1MnpIzPrGtLcijffmeouNlQ==",
+ "version": "4.8.0",
+ "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.8.0.tgz",
+ "integrity": "sha512-C0jdhD5yQahMws9alf/yvtsMGTaIDBnZ8Rb5HU56svyq0l5LIrGzIDZZD5pHQlmzxLuU91Gz+VpQMKgCTNYtkw==",
"dev": true,
"dependencies": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.3.2",
- "engine.io-client": "~6.5.2",
+ "engine.io-client": "~6.6.1",
"socket.io-parser": "~4.2.4"
},
"engines": {
@@ -12043,17 +12034,6 @@
"ms": "^2.1.1"
}
},
- "node_modules/superagent/node_modules/mime": {
- "version": "1.6.0",
- "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz",
- "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==",
- "bin": {
- "mime": "cli.js"
- },
- "engines": {
- "node": ">=4"
- }
- },
"node_modules/superagent/node_modules/readable-stream": {
"version": "2.3.7",
"resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.7.tgz",
@@ -12699,6 +12679,11 @@
"punycode": "^2.1.0"
}
},
+ "node_modules/uri-js-replace": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/uri-js-replace/-/uri-js-replace-1.0.1.tgz",
+ "integrity": "sha512-W+C9NWNLFOoBI2QWDp4UT9pv65r2w5Cx+3sTYFvtMdDBxkKt1syCqsUdSFAChbEe1uK5TfS04wt/nGwmaeIQ0g=="
+ },
"node_modules/url-template": {
"version": "2.0.8",
"resolved": "https://registry.npmjs.org/url-template/-/url-template-2.0.8.tgz",
@@ -12945,9 +12930,9 @@
"dev": true
},
"node_modules/xmlhttprequest-ssl": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/xmlhttprequest-ssl/-/xmlhttprequest-ssl-2.0.0.tgz",
- "integrity": "sha512-QKxVRxiRACQcVuQEYFsI1hhkrMlrXHPegbbd1yn9UHOmRxY+si12nQYzri3vbzt8VdTTRviqcKxcyllFas5z2A==",
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/xmlhttprequest-ssl/-/xmlhttprequest-ssl-2.1.1.tgz",
+ "integrity": "sha512-ptjR8YSJIXoA3Mbv5po7RtSYHO6mZr8s7i5VGmEk7QY2pQWyT1o0N+W1gKbOyJPUCGXGnuw0wqe8f0L6Y0ny7g==",
"dev": true,
"engines": {
"node": ">=0.4.0"
@@ -14716,14 +14701,14 @@
"dev": true
},
"@redocly/ajv": {
- "version": "8.11.0",
- "resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.11.0.tgz",
- "integrity": "sha512-9GWx27t7xWhDIR02PA18nzBdLcKQRgc46xNQvjFkrYk4UOmvKhJ/dawwiX0cCOeetN5LcaaiqQbVOWYK62SGHw==",
+ "version": "8.11.2",
+ "resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.11.2.tgz",
+ "integrity": "sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==",
"requires": {
"fast-deep-equal": "^3.1.1",
"json-schema-traverse": "^1.0.0",
"require-from-string": "^2.0.2",
- "uri-js": "^4.2.2"
+ "uri-js-replace": "^1.0.1"
}
},
"@redocly/cli": {
@@ -14791,9 +14776,9 @@
}
},
"@redocly/config": {
- "version": "0.10.1",
- "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.10.1.tgz",
- "integrity": "sha512-H3LnKVGzOaxskwJu8pmJYwBOWjP61qOK7TuTrbafqArDVckE06fhA6l0nO4KvBbjLPjy1Al7UnlxOu23V4Nl0w=="
+ "version": "0.11.0",
+ "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.11.0.tgz",
+ "integrity": "sha512-vAc77vCuWsVgLx2LN02P6jqLBhHuot6O1LsSJEAAkWEvXARSGSQVon50QW7jlbCMg9OFTYYYRPN4W6K/YmnM3w=="
},
"@redocly/openapi-cli": {
"version": "1.0.0-beta.95",
@@ -15087,9 +15072,9 @@
}
},
"@types/jest": {
- "version": "29.5.12",
- "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.12.tgz",
- "integrity": "sha512-eDC8bTvT/QhYdxJAulQikueigY5AsdBRH2yDKW3yveW7svY3+DzN84/2NUgkw10RTiJbWqZrTtoGVdYlvFJdLw==",
+ "version": "29.5.13",
+ "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.13.tgz",
+ "integrity": "sha512-wd+MVEZCHt23V0/L642O5APvspWply/rGY5BcW4SUETo2UzPU3Z26qr8jC2qxpimI2jjx9h7+2cj2FwIr01bXg==",
"dev": true,
"requires": {
"expect": "^29.0.0",
@@ -15165,16 +15150,16 @@
"dev": true
},
"@typescript-eslint/eslint-plugin": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.5.0.tgz",
- "integrity": "sha512-lHS5hvz33iUFQKuPFGheAB84LwcJ60G8vKnEhnfcK1l8kGVLro2SFYW6K0/tj8FUhRJ0VHyg1oAfg50QGbPPHw==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.7.0.tgz",
+ "integrity": "sha512-RIHOoznhA3CCfSTFiB6kBGLQtB/sox+pJ6jeFu6FxJvqL8qRxq/FfGO/UhsGgQM9oGdXkV4xUgli+dt26biB6A==",
"dev": true,
"requires": {
"@eslint-community/regexpp": "^4.10.0",
- "@typescript-eslint/scope-manager": "8.5.0",
- "@typescript-eslint/type-utils": "8.5.0",
- "@typescript-eslint/utils": "8.5.0",
- "@typescript-eslint/visitor-keys": "8.5.0",
+ "@typescript-eslint/scope-manager": "8.7.0",
+ "@typescript-eslint/type-utils": "8.7.0",
+ "@typescript-eslint/utils": "8.7.0",
+ "@typescript-eslint/visitor-keys": "8.7.0",
"graphemer": "^1.4.0",
"ignore": "^5.3.1",
"natural-compare": "^1.4.0",
@@ -15182,54 +15167,54 @@
}
},
"@typescript-eslint/parser": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.5.0.tgz",
- "integrity": "sha512-gF77eNv0Xz2UJg/NbpWJ0kqAm35UMsvZf1GHj8D9MRFTj/V3tAciIWXfmPLsAAF/vUlpWPvUDyH1jjsr0cMVWw==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.7.0.tgz",
+ "integrity": "sha512-lN0btVpj2unxHlNYLI//BQ7nzbMJYBVQX5+pbNXvGYazdlgYonMn4AhhHifQ+J4fGRYA/m1DjaQjx+fDetqBOQ==",
"dev": true,
"requires": {
- "@typescript-eslint/scope-manager": "8.5.0",
- "@typescript-eslint/types": "8.5.0",
- "@typescript-eslint/typescript-estree": "8.5.0",
- "@typescript-eslint/visitor-keys": "8.5.0",
+ "@typescript-eslint/scope-manager": "8.7.0",
+ "@typescript-eslint/types": "8.7.0",
+ "@typescript-eslint/typescript-estree": "8.7.0",
+ "@typescript-eslint/visitor-keys": "8.7.0",
"debug": "^4.3.4"
}
},
"@typescript-eslint/scope-manager": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.5.0.tgz",
- "integrity": "sha512-06JOQ9Qgj33yvBEx6tpC8ecP9o860rsR22hWMEd12WcTRrfaFgHr2RB/CA/B+7BMhHkXT4chg2MyboGdFGawYg==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.7.0.tgz",
+ "integrity": "sha512-87rC0k3ZlDOuz82zzXRtQ7Akv3GKhHs0ti4YcbAJtaomllXoSO8hi7Ix3ccEvCd824dy9aIX+j3d2UMAfCtVpg==",
"dev": true,
"requires": {
- "@typescript-eslint/types": "8.5.0",
- "@typescript-eslint/visitor-keys": "8.5.0"
+ "@typescript-eslint/types": "8.7.0",
+ "@typescript-eslint/visitor-keys": "8.7.0"
}
},
"@typescript-eslint/type-utils": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.5.0.tgz",
- "integrity": "sha512-N1K8Ix+lUM+cIDhL2uekVn/ZD7TZW+9/rwz8DclQpcQ9rk4sIL5CAlBC0CugWKREmDjBzI/kQqU4wkg46jWLYA==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.7.0.tgz",
+ "integrity": "sha512-tl0N0Mj3hMSkEYhLkjREp54OSb/FI6qyCzfiiclvJvOqre6hsZTGSnHtmFLDU8TIM62G7ygEa1bI08lcuRwEnQ==",
"dev": true,
"requires": {
- "@typescript-eslint/typescript-estree": "8.5.0",
- "@typescript-eslint/utils": "8.5.0",
+ "@typescript-eslint/typescript-estree": "8.7.0",
+ "@typescript-eslint/utils": "8.7.0",
"debug": "^4.3.4",
"ts-api-utils": "^1.3.0"
}
},
"@typescript-eslint/types": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.5.0.tgz",
- "integrity": "sha512-qjkormnQS5wF9pjSi6q60bKUHH44j2APxfh9TQRXK8wbYVeDYYdYJGIROL87LGZZ2gz3Rbmjc736qyL8deVtdw==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.7.0.tgz",
+ "integrity": "sha512-LLt4BLHFwSfASHSF2K29SZ+ZCsbQOM+LuarPjRUuHm+Qd09hSe3GCeaQbcCr+Mik+0QFRmep/FyZBO6fJ64U3w==",
"dev": true
},
"@typescript-eslint/typescript-estree": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.5.0.tgz",
- "integrity": "sha512-vEG2Sf9P8BPQ+d0pxdfndw3xIXaoSjliG0/Ejk7UggByZPKXmJmw3GW5jV2gHNQNawBUyfahoSiCFVov0Ruf7Q==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.7.0.tgz",
+ "integrity": "sha512-MC8nmcGHsmfAKxwnluTQpNqceniT8SteVwd2voYlmiSWGOtjvGXdPl17dYu2797GVscK30Z04WRM28CrKS9WOg==",
"dev": true,
"requires": {
- "@typescript-eslint/types": "8.5.0",
- "@typescript-eslint/visitor-keys": "8.5.0",
+ "@typescript-eslint/types": "8.7.0",
+ "@typescript-eslint/visitor-keys": "8.7.0",
"debug": "^4.3.4",
"fast-glob": "^3.3.2",
"is-glob": "^4.0.3",
@@ -15259,24 +15244,24 @@
}
},
"@typescript-eslint/utils": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.5.0.tgz",
- "integrity": "sha512-6yyGYVL0e+VzGYp60wvkBHiqDWOpT63pdMV2CVG4LVDd5uR6q1qQN/7LafBZtAtNIn/mqXjsSeS5ggv/P0iECw==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.7.0.tgz",
+ "integrity": "sha512-ZbdUdwsl2X/s3CiyAu3gOlfQzpbuG3nTWKPoIvAu1pu5r8viiJvv2NPN2AqArL35NCYtw/lrPPfM4gxrMLNLPw==",
"dev": true,
"requires": {
"@eslint-community/eslint-utils": "^4.4.0",
- "@typescript-eslint/scope-manager": "8.5.0",
- "@typescript-eslint/types": "8.5.0",
- "@typescript-eslint/typescript-estree": "8.5.0"
+ "@typescript-eslint/scope-manager": "8.7.0",
+ "@typescript-eslint/types": "8.7.0",
+ "@typescript-eslint/typescript-estree": "8.7.0"
}
},
"@typescript-eslint/visitor-keys": {
- "version": "8.5.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.5.0.tgz",
- "integrity": "sha512-yTPqMnbAZJNy2Xq2XU8AdtOW9tJIr+UQb64aXB9f3B1498Zx9JorVgFJcZpEc9UBuCCrdzKID2RGAMkYcDtZOw==",
+ "version": "8.7.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.7.0.tgz",
+ "integrity": "sha512-b1tx0orFCCh/THWPQa2ZwWzvOeyzzp36vkJYOpVg0u8UVOIsfVrnuC9FqAw9gRKn+rG2VmWQ/zDJZzkxUnj/XQ==",
"dev": true,
"requires": {
- "@typescript-eslint/types": "8.5.0",
+ "@typescript-eslint/types": "8.7.0",
"eslint-visitor-keys": "^3.4.3"
}
},
@@ -15665,13 +15650,13 @@
}
},
"browser-sync": {
- "version": "3.0.2",
- "resolved": "https://registry.npmjs.org/browser-sync/-/browser-sync-3.0.2.tgz",
- "integrity": "sha512-PC9c7aWJFVR4IFySrJxOqLwB9ENn3/TaXCXtAa0SzLwocLN3qMjN+IatbjvtCX92BjNXsY6YWg9Eb7F3Wy255g==",
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/browser-sync/-/browser-sync-3.0.3.tgz",
+ "integrity": "sha512-91hoBHKk1C4pGeD+oE9Ld222k2GNQEAsI5AElqR8iLLWNrmZR2LPP8B0h8dpld9u7kro5IEUB3pUb0DJ3n1cRQ==",
"dev": true,
"requires": {
- "browser-sync-client": "^3.0.2",
- "browser-sync-ui": "^3.0.2",
+ "browser-sync-client": "^3.0.3",
+ "browser-sync-ui": "^3.0.3",
"bs-recipes": "1.3.4",
"chalk": "4.1.2",
"chokidar": "^3.5.1",
@@ -15685,15 +15670,15 @@
"fs-extra": "3.0.1",
"http-proxy": "^1.18.1",
"immutable": "^3",
- "micromatch": "^4.0.2",
+ "micromatch": "^4.0.8",
"opn": "5.3.0",
"portscanner": "2.2.0",
"raw-body": "^2.3.2",
"resp-modifier": "6.0.2",
"rx": "4.1.0",
- "send": "0.16.2",
- "serve-index": "1.9.1",
- "serve-static": "1.13.2",
+ "send": "^0.19.0",
+ "serve-index": "^1.9.1",
+ "serve-static": "^1.16.2",
"server-destroy": "1.0.1",
"socket.io": "^4.4.1",
"ua-parser-js": "^1.0.33",
@@ -15729,9 +15714,9 @@
}
},
"browser-sync-client": {
- "version": "3.0.2",
- "resolved": "https://registry.npmjs.org/browser-sync-client/-/browser-sync-client-3.0.2.tgz",
- "integrity": "sha512-tBWdfn9L0wd2Pjuz/NWHtNEKthVb1Y67vg8/qyGNtCqetNz5lkDkFnrsx5UhPNPYUO8vci50IWC/BhYaQskDiQ==",
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/browser-sync-client/-/browser-sync-client-3.0.3.tgz",
+ "integrity": "sha512-TOEXaMgYNjBYIcmX5zDlOdjEqCeCN/d7opf/fuyUD/hhGVCfP54iQIDhENCi012AqzYZm3BvuFl57vbwSTwkSQ==",
"dev": true,
"requires": {
"etag": "1.8.1",
@@ -15740,9 +15725,9 @@
}
},
"browser-sync-ui": {
- "version": "3.0.2",
- "resolved": "https://registry.npmjs.org/browser-sync-ui/-/browser-sync-ui-3.0.2.tgz",
- "integrity": "sha512-V3FwWAI+abVbFLTyJjXJlCMBwjc3GXf/BPGfwO2fMFACWbIGW9/4SrBOFYEOOtqzCjQE0Di+U3VIb7eES4omNA==",
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/browser-sync-ui/-/browser-sync-ui-3.0.3.tgz",
+ "integrity": "sha512-FcGWo5lP5VodPY6O/f4pXQy5FFh4JK0f2/fTBsp0Lx1NtyBWs/IfPPJbW8m1ujTW/2r07oUXKTF2LYZlCZktjw==",
"dev": true,
"requires": {
"async-each-series": "0.1.1",
@@ -16661,9 +16646,9 @@
"dev": true
},
"destroy": {
- "version": "1.0.4",
- "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.0.4.tgz",
- "integrity": "sha512-3NdhDuEXnfun/z7x9GOElY49LoqVHoGScmOKwmxhsS8N5Y+Z8KyPPDnaSzqWgYt/ji4mqwfTS34Htrk0zPIXVg==",
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz",
+ "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==",
"dev": true
},
"detect-indent": {
@@ -16706,9 +16691,9 @@
}
},
"dompurify": {
- "version": "2.4.7",
- "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-2.4.7.tgz",
- "integrity": "sha512-kxxKlPEDa6Nc5WJi+qRgPbOAbgTpSULL+vI3NUXsZMlkJxTqYI9wg5ZTay2sFrdZRWHPWNi+EdAhcJf81WtoMQ==",
+ "version": "2.5.6",
+ "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-2.5.6.tgz",
+ "integrity": "sha512-zUTaUBO8pY4+iJMPE1B9XlO2tXVYIcEA4SNGtvDELzTSCQO7RzH+j7S180BmhmJId78lqGU2z19vgVx2Sxs/PQ==",
"dev": true
},
"dot-prop": {
@@ -16876,16 +16861,16 @@
}
},
"engine.io-client": {
- "version": "6.5.4",
- "resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-6.5.4.tgz",
- "integrity": "sha512-GeZeeRjpD2qf49cZQ0Wvh/8NJNfeXkXXcoGh+F77oEAgo9gUHwT1fCRxSNU+YEEaysOJTnsFHmM5oAcPy4ntvQ==",
+ "version": "6.6.1",
+ "resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-6.6.1.tgz",
+ "integrity": "sha512-aYuoak7I+R83M/BBPIOs2to51BmFIpC1wZe6zZzMrT2llVsHy5cvcmdsJgP2Qz6smHu+sD9oexiSUAVd8OfBPw==",
"dev": true,
"requires": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.3.1",
"engine.io-parser": "~5.2.1",
"ws": "~8.17.1",
- "xmlhttprequest-ssl": "~2.0.0"
+ "xmlhttprequest-ssl": "~2.1.1"
},
"dependencies": {
"ws": {
@@ -18275,9 +18260,9 @@
"dev": true
},
"husky": {
- "version": "9.1.5",
- "resolved": "https://registry.npmjs.org/husky/-/husky-9.1.5.tgz",
- "integrity": "sha512-rowAVRUBfI0b4+niA4SJMhfQwc107VLkBUgEYYAOQAbqDCnra1nYh83hF/MDmhYs9t9n1E3DuKOrs2LYNC+0Ag==",
+ "version": "9.1.6",
+ "resolved": "https://registry.npmjs.org/husky/-/husky-9.1.6.tgz",
+ "integrity": "sha512-sqbjZKK7kf44hfdE94EoX8MZNk0n7HeW37O4YrVGCF4wzgQjp+akPAkfUK5LZ6KuR/6sqeAVuXHji+RzQgOn5A==",
"dev": true
},
"iconv-lite": {
@@ -19830,10 +19815,9 @@
}
},
"mime": {
- "version": "1.4.1",
- "resolved": "https://registry.npmjs.org/mime/-/mime-1.4.1.tgz",
- "integrity": "sha512-KI1+qOZu5DcW6wayYHSzR/tXKCDC5Om4s1z2QJjDULzLcmf3DvzS7oluY4HCTrc+9FiKmWUgeNLg7W3uIQvxtQ==",
- "dev": true
+ "version": "1.6.0",
+ "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz",
+ "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg=="
},
"mime-db": {
"version": "1.52.0",
@@ -20023,9 +20007,9 @@
"dev": true
},
"npm-check-updates": {
- "version": "17.1.1",
- "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-17.1.1.tgz",
- "integrity": "sha512-2aqIzGAEWB7xPf0hKHTkNmUM5jHbn2S5r2/z/7dA5Ij2h/sVYAg9R/uVkaUC3VORPAfBm7pKkCWo6E9clEVQ9A==",
+ "version": "17.1.3",
+ "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-17.1.3.tgz",
+ "integrity": "sha512-4uDLBWPuDHT5KLieIJ20FoAB8yqJejmupI42wPyfObgQOBbPAikQSwT73afDwREvhuxYrRDqlRvxTMSfvO+L8A==",
"dev": true
},
"npm-run-path": {
@@ -20222,11 +20206,11 @@
"integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw=="
},
"openapi-typescript": {
- "version": "7.4.0",
- "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-7.4.0.tgz",
- "integrity": "sha512-u4iVuTGkzKG4rHFUMA/IFXTks9tYVQzkowZsScMOdzJSvIF10qSNySWHTwnN2fD+MEeWFAM8i1f3IUBlgS92eQ==",
+ "version": "7.4.1",
+ "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-7.4.1.tgz",
+ "integrity": "sha512-HrRoWveViADezHCNgQqZmPKmQ74q7nuH/yg9ursFucZaYQNUqsX38fE/V2sKBHVM+pws4tAHpuh/ext2UJ/AoQ==",
"requires": {
- "@redocly/openapi-core": "^1.16.0",
+ "@redocly/openapi-core": "^1.25.3",
"ansi-colors": "^4.1.3",
"change-case": "^5.4.4",
"parse-json": "^8.1.0",
@@ -20235,12 +20219,12 @@
},
"dependencies": {
"@redocly/openapi-core": {
- "version": "1.22.1",
- "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.22.1.tgz",
- "integrity": "sha512-pjr456gJzrbwPvBjFKlWOd9nZEcr/dp6XSH0c8ijWGWv5K+V0vpUUy2zaTAVsFAoCydx1miEoOcbLhWQ9WC2nw==",
+ "version": "1.25.3",
+ "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.25.3.tgz",
+ "integrity": "sha512-dqJkyydgagW3FXX5cjtSUAnabsld4K6yq7RFgQ+ngI1m43PkEoSQt8pp+SfQDszSEoMbc7QKj8afbe7mZw17TA==",
"requires": {
- "@redocly/ajv": "^8.11.0",
- "@redocly/config": "^0.10.1",
+ "@redocly/ajv": "^8.11.2",
+ "@redocly/config": "^0.11.0",
"colorette": "^1.2.0",
"https-proxy-agent": "^7.0.4",
"js-levenshtein": "^1.1.6",
@@ -21188,24 +21172,24 @@
"dev": true
},
"send": {
- "version": "0.16.2",
- "resolved": "https://registry.npmjs.org/send/-/send-0.16.2.tgz",
- "integrity": "sha512-E64YFPUssFHEFBvpbbjr44NCLtI1AohxQ8ZSiJjQLskAdKuriYEP6VyGEsRDH8ScozGpkaX1BGvhanqCwkcEZw==",
+ "version": "0.19.0",
+ "resolved": "https://registry.npmjs.org/send/-/send-0.19.0.tgz",
+ "integrity": "sha512-dW41u5VfLXu8SJh5bwRmyYUbAoSB3c9uQh6L8h/KtsFREPWpbX1lrljJo186Jc4nmci/sGUZ9a0a0J2zgfq2hw==",
"dev": true,
"requires": {
"debug": "2.6.9",
- "depd": "~1.1.2",
- "destroy": "~1.0.4",
+ "depd": "2.0.0",
+ "destroy": "1.2.0",
"encodeurl": "~1.0.2",
"escape-html": "~1.0.3",
"etag": "~1.8.1",
"fresh": "0.5.2",
- "http-errors": "~1.6.2",
- "mime": "1.4.1",
- "ms": "2.0.0",
- "on-finished": "~2.3.0",
- "range-parser": "~1.2.0",
- "statuses": "~1.4.0"
+ "http-errors": "2.0.0",
+ "mime": "1.6.0",
+ "ms": "2.1.3",
+ "on-finished": "2.4.1",
+ "range-parser": "~1.2.1",
+ "statuses": "2.0.1"
},
"dependencies": {
"debug": {
@@ -21215,48 +21199,29 @@
"dev": true,
"requires": {
"ms": "2.0.0"
+ },
+ "dependencies": {
+ "ms": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+ "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==",
+ "dev": true
+ }
}
},
- "depd": {
- "version": "1.1.2",
- "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz",
- "integrity": "sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ==",
- "dev": true
- },
- "http-errors": {
- "version": "1.6.3",
- "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.6.3.tgz",
- "integrity": "sha512-lks+lVC8dgGyh97jxvxeYTWQFvh4uw4yC12gVl63Cg30sjPX4wuGcdkICVXDAESr6OJGjqGA8Iz5mkeN6zlD7A==",
+ "on-finished": {
+ "version": "2.4.1",
+ "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz",
+ "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==",
"dev": true,
"requires": {
- "depd": "~1.1.2",
- "inherits": "2.0.3",
- "setprototypeof": "1.1.0",
- "statuses": ">= 1.4.0 < 2"
+ "ee-first": "1.1.1"
}
},
- "inherits": {
- "version": "2.0.3",
- "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz",
- "integrity": "sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw==",
- "dev": true
- },
- "ms": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
- "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==",
- "dev": true
- },
- "setprototypeof": {
- "version": "1.1.0",
- "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.0.tgz",
- "integrity": "sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ==",
- "dev": true
- },
"statuses": {
- "version": "1.4.0",
- "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.4.0.tgz",
- "integrity": "sha512-zhSCtt8v2NDrRlPQpCNtw/heZLtfUDqxBM1udqikb/Hbk52LK4nQSwr10u77iopCW5LsyHpuXS0GnEc48mLeew==",
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz",
+ "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==",
"dev": true
}
}
@@ -21330,15 +21295,23 @@
}
},
"serve-static": {
- "version": "1.13.2",
- "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.13.2.tgz",
- "integrity": "sha512-p/tdJrO4U387R9oMjb1oj7qSMaMfmOyd4j9hOFoxZe2baQszgHcSWjuya/CiT5kgZZKRudHNOA0pYXOl8rQ5nw==",
+ "version": "1.16.2",
+ "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.16.2.tgz",
+ "integrity": "sha512-VqpjJZKadQB/PEbEwvFdO43Ax5dFBZ2UECszz8bQ7pi7wt//PWe1P6MN7eCnjsatYtBT6EuiClbjSWP2WrIoTw==",
"dev": true,
"requires": {
- "encodeurl": "~1.0.2",
+ "encodeurl": "~2.0.0",
"escape-html": "~1.0.3",
- "parseurl": "~1.3.2",
- "send": "0.16.2"
+ "parseurl": "~1.3.3",
+ "send": "0.19.0"
+ },
+ "dependencies": {
+ "encodeurl": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz",
+ "integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==",
+ "dev": true
+ }
}
},
"server-destroy": {
@@ -21558,14 +21531,14 @@
}
},
"socket.io-client": {
- "version": "4.7.5",
- "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.7.5.tgz",
- "integrity": "sha512-sJ/tqHOCe7Z50JCBCXrsY3I2k03iOiUe+tj1OmKeD2lXPiGH/RUCdTZFoqVyN7l1MnpIzPrGtLcijffmeouNlQ==",
+ "version": "4.8.0",
+ "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.8.0.tgz",
+ "integrity": "sha512-C0jdhD5yQahMws9alf/yvtsMGTaIDBnZ8Rb5HU56svyq0l5LIrGzIDZZD5pHQlmzxLuU91Gz+VpQMKgCTNYtkw==",
"dev": true,
"requires": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.3.2",
- "engine.io-client": "~6.5.2",
+ "engine.io-client": "~6.6.1",
"socket.io-parser": "~4.2.4"
}
},
@@ -22016,11 +21989,6 @@
"ms": "^2.1.1"
}
},
- "mime": {
- "version": "1.6.0",
- "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz",
- "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg=="
- },
"readable-stream": {
"version": "2.3.7",
"resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.7.tgz",
@@ -22451,6 +22419,11 @@
"punycode": "^2.1.0"
}
},
+ "uri-js-replace": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/uri-js-replace/-/uri-js-replace-1.0.1.tgz",
+ "integrity": "sha512-W+C9NWNLFOoBI2QWDp4UT9pv65r2w5Cx+3sTYFvtMdDBxkKt1syCqsUdSFAChbEe1uK5TfS04wt/nGwmaeIQ0g=="
+ },
"url-template": {
"version": "2.0.8",
"resolved": "https://registry.npmjs.org/url-template/-/url-template-2.0.8.tgz",
@@ -22643,9 +22616,9 @@
"dev": true
},
"xmlhttprequest-ssl": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/xmlhttprequest-ssl/-/xmlhttprequest-ssl-2.0.0.tgz",
- "integrity": "sha512-QKxVRxiRACQcVuQEYFsI1hhkrMlrXHPegbbd1yn9UHOmRxY+si12nQYzri3vbzt8VdTTRviqcKxcyllFas5z2A==",
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/xmlhttprequest-ssl/-/xmlhttprequest-ssl-2.1.1.tgz",
+ "integrity": "sha512-ptjR8YSJIXoA3Mbv5po7RtSYHO6mZr8s7i5VGmEk7QY2pQWyT1o0N+W1gKbOyJPUCGXGnuw0wqe8f0L6Y0ny7g==",
"dev": true
},
"xtend": {
diff --git a/package.json b/package.json
index 4ab2ed37..987b19ce 100644
--- a/package.json
+++ b/package.json
@@ -86,7 +86,7 @@
"js-yaml": "^4.1.0",
"json-refs": "^3.0.15",
"openapi-types": "^12.1.3",
- "openapi-typescript": "^7.4.0",
+ "openapi-typescript": "^7.4.1",
"ts-auto-mock": "^3.7.4"
},
"overrides": {
@@ -98,12 +98,12 @@
"@commitlint/config-conventional": "^19.5.0",
"@redocly/openapi-cli": "^1.0.0-beta.95",
"@redocly/cli": "^1.5.0",
- "@types/jest": "^29.5.12",
+ "@types/jest": "^29.5.13",
"@types/js-yaml": "^4.0.9",
- "@typescript-eslint/eslint-plugin": "^8.5.0",
- "@typescript-eslint/parser": "^8.5.0",
+ "@typescript-eslint/eslint-plugin": "^8.7.0",
+ "@typescript-eslint/parser": "^8.7.0",
"audit-ci": "^7.1.0",
- "browser-sync": "^3.0.2",
+ "browser-sync": "^3.0.3",
"diff": "^7.0.0",
"eslint": "^8.55.0",
"eslint-config-prettier": "^9.1.0",
@@ -115,11 +115,11 @@
"eslint-plugin-prettier": "^5.2.1",
"eslint-plugin-promise": "^6.2.0",
"eslint-plugin-standard": "^5.0.0",
- "husky": "9.1.5",
+ "husky": "9.1.6",
"jest": "^29.7.0",
"jest-junit": "^16.0.0",
"lint-staged": "^15.2.10",
- "npm-check-updates": "^17.1.1",
+ "npm-check-updates": "^17.1.3",
"prettier": "^3.3.3",
"standard-version": "^9.5.0",
"swagger-cli": "^4.0.4",
diff --git a/src/fspiop/v2_0_ISO20022/json-schemas.json b/src/fspiop/v2_0_ISO20022/json-schemas.json
index c1053b36..23eeada1 100644
--- a/src/fspiop/v2_0_ISO20022/json-schemas.json
+++ b/src/fspiop/v2_0_ISO20022/json-schemas.json
@@ -3,93 +3,146 @@
"title": "AccountIdentification4Choice",
"type": "object",
"description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "IBAN": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "IBAN\nInternational 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.\n"
}
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
"required": [
"IBAN"
]
},
{
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
"required": [
"Othr"
]
@@ -103,31 +156,47 @@
"title": "AccountSchemeName1Choice",
"type": "object",
"description": "Sets of elements to identify a name of the identification scheme.\n",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
@@ -143,18 +212,29 @@
"description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
"ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
},
"Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
"required": [
@@ -186,17 +266,31 @@
"description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
"ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
},
"Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
"required": [
@@ -222,7 +316,7 @@
"example": "USD"
},
"AddressType2Code": {
- "description": "AddressType2Code\n\nSpecifies the type of address.\n",
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
"enum": [
"ADDR",
"PBOX",
@@ -238,67 +332,104 @@
"title": "AddressType3Choice",
"type": "object",
"description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
@@ -335,130 +466,305 @@
"description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
"FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
"type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
{
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
+ ]
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "example": "ADDR"
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Issr": {
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -466,347 +772,55 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Issr": {
+ "DstrctNm": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -814,722 +828,408 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Othr": {
+ "allOf": [
{
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
+ "required": [],
"example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
}
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
+ ]
},
"BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "BranchAndFinancialInstitutionIdentification8": {
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
+ "allOf": [
+ {
+ "title": "BranchData3",
"type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
+ "Id": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ ]
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
- "example": "ADDR"
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Nm": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
},
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "PstlAdr": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Issr": {
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -1537,217 +1237,132 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
}
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
}
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
+ ]
}
},
"required": [
@@ -1775,1378 +1390,908 @@
}
}
},
- "BranchData3": {
- "title": "BranchData3",
+ "BranchAndFinancialInstitutionIdentification8": {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
- "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- },
- "BranchData5": {
- "title": "BranchData5",
- "description": "Information that locates and identifies a specific branch of a financial institution.\n",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 140,
+ "example": 12345
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- },
- "CashAccount40": {
- "title": "CashAccount40",
- "type": "object",
- "description": "Provides the details to identify an account.\n",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Othr": {
+ "allOf": [
{
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
}
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
- "required": [
- "Id"
- ],
+ "required": [],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
},
- {
- "required": [
- "Prtry"
- ]
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
}
- ],
- "example": {
- "Cd": "CH03"
}
},
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "CashAccountType2Choice": {
- "title": "CashAccountType2Choice",
- "description": "Specifies the nature, or use of the account.\n",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "CategoryPurpose1Choice": {
- "title": "CategoryPurpose1Choice",
- "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- },
- "ChargeBearerType1Code": {
- "title": "ChargeBearerType1Code",
- "description": "Specifies which party(ies) will pay charges due for processing of the instruction.\nDEBT BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver\nSLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level.\n",
- "type": "string",
- "enum": [
- "DEBT",
- "CRED",
- "SHAR",
- "SLEV"
- ],
- "example": "DEBT"
- },
- "ChargeType3Choice": {
- "title": "ChargeType3Choice",
- "description": "ChargeType3Choice\nSpecifies the type of charge.\n",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCharge type, in a coded form.\n",
- "title": "ExternalChargeType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n",
- "title": "GenericIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- },
- "Charges16": {
- "title": "Charges16",
- "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n",
- "type": "object",
- "properties": {
- "Amt": {
- "description": "Amount\n\n Transaction charges to be paid by the charge bearer.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Agt": {
- "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
+ "Id": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
},
- "MmbId": 123456789
- }
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
},
"LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
},
"Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
},
"PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "allOf": [
+ {
+ "title": "PostalAddress27",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "AdrTp": {
+ "title": "AddressType3Choice",
"type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "Id",
- "Issr"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Cd": "ADDR"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 140,
+ "example": 12345
},
- "Prtry": {
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
- {
- "required": [
- "Prtry"
- ]
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
- ],
+ },
"example": {
- "Cd": "BIC"
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
+ ]
}
},
"example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
+ "Id": 123,
"LEI": 123,
"Nm": "Name",
"PstlAdr": {
@@ -3154,350 +2299,241 @@
"Dept": "Department",
"SubDept": "Sub department",
"StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
+ "BldgNb": "Building number"
}
}
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ "BranchData3": {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ "AdrTp": {
+ "title": "AddressType3Choice",
"type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
"properties": {
"Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "example": "ADDR"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Code\nType of address expressed as a code.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ },
+ "required": [
+ "Cd"
+ ]
},
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
+ ],
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "Cd": "ADDR"
}
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Tp": {
- "description": "Type\n\n Defines the type of charges.\n",
- "title": "ChargeType3Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCharge type, in a coded form.\n",
- "title": "ExternalChargeType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n",
- "title": "GenericIdentification3",
- "type": "object",
- "properties": {
- "Id": {
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -3505,918 +2541,767 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Issr": {
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "Id"
- ],
"example": {
- "Id": 123,
- "Issr": "BIC"
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- ],
- "example": {
- "Cd": "CASH"
- }
+ ]
}
},
- "required": [
- "Amt",
- "Agt"
- ],
"example": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- }
- },
- "ClearingChannel2Code": {
- "title": "ClearingChannel2Code",
- "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "ClearingSystemIdentification2Choice": {
- "title": "ClearingSystemIdentification2Choice",
- "description": "Choice of a clearing system identifier.\n",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
}
- ],
- "example": {
- "Cd": "CHQB"
}
},
- "ClearingSystemMemberIdentification2": {
- "title": "ClearingSystemMemberIdentification2",
- "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "BranchData5": {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
+ "Id": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "LEI": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "Contact13": {
- "title": "Contact13",
- "description": "Specifies the details of the contact person.\n",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
+ ]
},
"Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
},
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- },
- "Contact4": {
- "title": "Contact4",
- "description": "Specifies the details of the contact person.\n",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- },
- "CountryCode": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CreditTransferTransaction67": {
- "title": "CreditTransferTransaction67",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n\n Set of elements used to further specify the type of transaction.\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 140,
+ "example": 12345
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
"example": 12345
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "maxLength": 16,
+ "example": 1234567890123456
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
"minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "maxLength": 16,
+ "example": 1234567890123456
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n",
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "InstdAmt": {
- "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "XchgRate": {
- "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n",
- "title": "BaseOneRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 0.7
- },
- "ChrgBr": {
- "description": "ChargeBearer\nSpecifies which party/parties will bear the charges associated with the processing of the payment transaction.\n",
- "title": "ChargeBearerType1Code",
- "type": "string",
- "enum": [
- "DEBT",
- "CRED",
- "SHAR",
- "SLEV"
- ],
- "example": "DEBT"
- },
- "ChrgsInf": {
- "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction\n",
- "title": "Charges16",
- "type": "object",
- "properties": {
- "Amt": {
- "description": "Amount\n\n Transaction charges to be paid by the charge bearer.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
"example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "Agt": {
- "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ "CashAccount40": {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
"type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
"properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
"type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "CHQB"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
}
},
- "MmbId": {
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
"type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
"properties": {
"Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
+ "minLength": 1,
+ "maxLength": 4,
"example": 1234
},
- "Issr": {
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -4424,205 +3309,230 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
+ ],
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "Cd": "EMAIL"
}
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
+ },
+ "CashAccountType2Choice": {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ "CategoryPurpose1Choice": {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ "ChargeBearerType1Code": {
+ "title": "ChargeBearerType1Code",
+ "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n",
+ "type": "string",
+ "enum": [
+ "DEBT",
+ "CRED",
+ "SHAR",
+ "SLEV"
+ ],
+ "example": "DEBT"
+ },
+ "ChargeType3Choice": {
+ "title": "ChargeType3Choice",
+ "description": "ChargeType3Choice\nSpecifies the type of charge.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalChargeType1Code",
+ "description": "Specifies the type of charge applied to the transaction.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCharge type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification3",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -4630,160 +3540,411 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
+ {
+ "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
},
- "Issr": "BIC"
- }
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
}
},
+ "required": [
+ "Id"
+ ],
"example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
+ "Id": 123,
+ "Issr": "BIC"
}
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
+ {
+ "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ "Charges16": {
+ "title": "Charges16",
+ "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n",
+ "type": "object",
+ "properties": {
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
},
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\nTransaction charges to be paid by the charge bearer.\n"
+ }
+ ]
+ },
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
"type": "string",
- "example": "ADDR"
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Issr": {
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -4791,217 +3952,611 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Othr": {
+ "allOf": [
{
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
},
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
},
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
},
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
},
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
},
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
}
},
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
+ ]
}
},
"required": [
@@ -5029,57 +4584,94 @@
}
}
},
- "Tp": {
- "description": "Type\n\n Defines the type of charges.\n",
+ {
+ "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
"title": "ChargeType3Choice",
+ "description": "ChargeType3Choice\nSpecifies the type of charge.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCharge type, in a coded form.\n",
- "title": "ExternalChargeType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n",
- "title": "GenericIdentification3",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalChargeType1Code",
+ "description": "Specifies the type of charge applied to the transaction.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCharge type, in a coded form.\n"
+ }
+ ]
}
},
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification3",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
@@ -5088,235 +4680,79 @@
"example": {
"Cd": "CASH"
}
- }
- },
- "required": [
- "Amt",
- "Agt"
- ],
- "example": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
},
- "Tp": {
- "Cd": "SHAR"
+ {
+ "description": "Type\nDefines the type of charges.\n"
}
+ ]
+ }
+ },
+ "required": [
+ "Amt",
+ "Agt"
+ ],
+ "example": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
}
},
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "PartyIdentification272",
- "type": "object",
+ "Tp": {
+ "Cd": "SHAR"
+ }
+ }
+ },
+ "ClearingChannel2Code": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "ClearingSystemIdentification2Choice": {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
+ "maxLength": 5,
"example": 12345
},
- "CtrySubDvsn": {
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -5324,177 +4760,60 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ "ClearingSystemMemberIdentification2": {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
"type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
"type": "string",
"minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
+ "maxLength": 5,
+ "example": 12345
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
+ "required": [
+ "Cd"
+ ]
},
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
+ {
"properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -5502,476 +4821,208 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
"required": [
- "PrvtId"
+ "Prtry"
]
}
],
"example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
+ "Cd": "CHIPS"
}
},
- "CtryOfRes": {
- "title": "CountryCode",
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
}
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ "Contact13": {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
},
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
}
- }
+ ]
},
- "DbtrAcct": {
- "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
},
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
},
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
"type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Nm": {
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
"title": "Max70Text",
"description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
@@ -5979,369 +5030,379 @@
"maxLength": 70,
"example": 1.2345678901234567e+99
},
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
"type": "object",
"properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 4,
"example": 1234
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Id": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ ]
}
},
"required": [
- "Id"
+ "ChanlTp"
],
"example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
+ "ChanlTp": "PHON",
+ "Id": 1234567890
}
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
}
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
},
- "Tp": {
- "Cd": "CACC"
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ "Contact4": {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
},
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
}
- }
+ ]
},
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "maxLength": 4,
+ "example": 1234
},
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
+ "maxLength": 128,
"example": 12345
},
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ "CountryCode": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "CreditTransferTransaction67": {
+ "title": "CreditTransferTransaction67",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
+ "type": "object",
+ "properties": {
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
+ "type": "object",
+ "properties": {
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
+ },
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "CtrySubDvsn": {
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -6349,49 +5410,27 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
+ }
+ ]
+ },
+ "UETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
"type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
+ "ClrSysRef": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -6399,603 +5438,1523 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "TxId"
+ ],
+ "example": {
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
+ }
+ },
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
+ }
+ ]
+ },
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
+ "type": "object",
+ "properties": {
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "SEPA"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ ]
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
+ {
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ "Prtry"
+ ]
}
- },
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "ADDR"
+ "Cd": "CASH"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
+ },
+ {
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
+ }
+ ]
+ },
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
},
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
+ }
+ ]
+ },
+ "InstdAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
},
- "Ctry": {
- "title": "CountryCode",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
}
},
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
"example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
+ },
+ {
+ "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n"
}
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
+ ]
+ },
+ "XchgRate": {
+ "allOf": [
+ {
+ "title": "BaseOneRate",
+ "type": "string",
+ "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 0.7
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ {
+ "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n"
}
- }
+ ]
},
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
+ "ChrgBr": {
+ "title": "ChargeBearerType1Code",
+ "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n",
+ "type": "string",
+ "enum": [
+ "DEBT",
+ "CRED",
+ "SHAR",
+ "SLEV"
+ ],
+ "example": "DEBT"
+ },
+ "ChrgsInf": {
+ "allOf": [
+ {
+ "title": "Charges16",
+ "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n",
"type": "object",
"properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
]
}
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Cd": "CHQB"
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Amount\nTransaction charges to be paid by the charge bearer.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ChargeType3Choice",
+ "description": "ChargeType3Choice\nSpecifies the type of charge.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalChargeType1Code",
+ "description": "Specifies the type of charge applied to the transaction.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCharge type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification3",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "ADDR"
+ "Cd": "CASH"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
+ {
+ "description": "Type\nDefines the type of charges.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt",
+ "Agt"
+ ],
+ "example": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
+ }
+ },
+ {
+ "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n"
+ }
+ ]
+ },
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
@@ -7003,298 +6962,848 @@
"maxLength": 140,
"example": 12345
},
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 140,
+ "example": 12345
},
- "Prtry": {
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
+ "OrgId"
]
},
{
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
+ "PrvtId"
]
}
],
"example": {
- "Cd": "BIC"
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "Issr": {
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -7302,91 +7811,432 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
+ }
+ ]
+ },
+ "DbtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
}
- },
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "ADDR"
+ "Cd": "CACC"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "Flr": {
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
"title": "Max70Text",
"description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
@@ -7394,1412 +8244,1661 @@
"maxLength": 70,
"example": 1.2345678901234567e+99
},
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "Id"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
},
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
+ {
+ "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n"
+ }
+ ]
+ },
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "BICFI": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
},
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
}
},
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
+ "required": [],
"example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
"Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "LEI": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
},
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
]
}
+ },
+ "required": [
+ "FinInstnId"
],
"example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
}
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
}
}
},
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
}
- }
+ ]
},
- "CdtrAcct": {
- "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
+ "CdtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
]
}
- ],
+ },
+ "required": [],
"example": {
- "Cd": 1111
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "BrnchId": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "InstrForNxtAgt": {
- "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForNextAgent1",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
- "title": "Instruction4Code",
- "type": "string",
- "enum": [
- "PHOA",
- "TELA"
- ],
- "example": "PHOA"
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone"
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "RgltryRptg": {
- "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n",
- "title": "RegulatoryReporting3",
- "type": "object",
- "properties": {
- "DbtCdtRptgInd": {
- "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "title": "RegulatoryReportingType1Code",
- "type": "string",
- "enum": [
- "CRED",
- "DEBT",
- "BOTH"
- ],
- "example": "BOTH"
- },
- "Authrty": {
- "description": "Authority\n\nEntity requiring the regulatory reporting information.\n",
- "title": "RegulatoryAuthority2",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "example": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- }
- },
- "Dtls": {
- "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "anyOf": [
- {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- },
- {
- "items": {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
+ "Id": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -8807,2041 +9906,1818 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "type": "array"
- }
- ]
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
},
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- },
- "type": "array"
+ ]
}
- ]
- }
- },
- "example": {
- "DbtCdtRptgInd": "CRED",
- "Authrty": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
},
- "Dtls": {
- "Cd": "A1",
- "Inf": "Mandatory regulatory information"
+ {
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
}
- }
+ ]
},
- "Tax": {
- "description": "Tax\nProvides details on the tax.\n",
- "title": "TaxData1",
- "type": "object",
- "properties": {
- "Cdtr": {
- "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n",
- "title": "TaxParty1",
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT"
- }
- },
- "Dbtr": {
- "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
+ "Nm": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 140,
"example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "UltmtDbtr": {
- "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
},
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
}
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "AdmstnZone": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RefNb": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Mtd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TtlTaxblBaseAmt": {
- "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlTaxAmt": {
- "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dt": {
- "description": "Date\n\nDate by which tax is due.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "SeqNb": {
- "description": "SequenceNumber\n\nSequential number of the tax report\n",
- "title": "Number",
- "type": "string",
- "pattern": "^[\\d\\-\\.\\,]{1,18}$",
- "example": 256
- },
- "Rcrd": {
- "description": "Record\n\nDetails of the tax record.\n",
- "anyOf": [
- {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
+ "AdrTp": {
+ "title": "AddressType3Choice",
"type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
{
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
"type": "object",
+ "description": "Generic scheme identification for a party.\n",
"properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
}
},
"required": [
- "FrDt",
- "ToDt"
+ "Id",
+ "Issr"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
}
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
+ ]
},
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
}
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ "Issr": "BIC"
}
}
},
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
}
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
}
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
}
- },
- "type": "array"
+ ]
}
+ },
+ "required": [
+ "PrvtId"
]
}
- },
+ ],
"example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
+ "OrgId": {
+ "AnyBIC": "BIC"
},
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
}
}
},
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
}
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "AddtlInf": "VAT applicable"
- }
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
},
- {
- "items": {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
}
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
+ ]
},
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
}
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
}
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
}
- }
+ ]
},
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
}
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ ]
}
},
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
+ }
+ ]
+ },
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
"type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
"type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "FrDt",
- "ToDt"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "Cd": 1111
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
}
- }
+ ]
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
+ "Id"
],
"example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ "Issr": "BIC"
}
},
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
},
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
}
},
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
}
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Cdtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "Dbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "UltmtDbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "AdmstnZone": "CH",
- "RefNb": 12345,
- "Mtd": "A",
- "TtlTaxblBaseAmt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "TtlTaxAmt": {
- "Ccy": "CHF",
- "Amt": 100
- },
- "Dt": "2018-01-01",
- "SeqNb": 1,
- "Rcrd": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
- },
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "ChrgBr",
- "Dbtr",
- "DbtrAgt",
- "CdtrAgt",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- },
- "SeqTp": "SEQTP"
- },
- "IntrBkSttlmAmt": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "InstdAmt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "XchgRate": 123.45,
- "ChrgBr": "SHAR",
- "ChrgsInf": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- },
- "Dbtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "CODE"
- },
- "InstrForNxtAgt": {
- "Cd": "CODE"
- },
- "Purp": {
- "Cd": "CASH"
- },
- "RgltryRptg": {
- "Dbtr": true,
- "Cdtr": true
- },
- "Tax": "Cdtr"
- }
- },
- "CreditTransferTransaction68": {
- "title": "CreditTransferTransaction68",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "title": "PaymentTypeInformation28",
- "description": "Provides further details of the type of payment.\n",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "CHQB"
+ "Cd": "CACC"
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
+ ]
},
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
},
"Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 2048,
+ "example": 2048
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "ADDR"
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
+ },
+ {
+ "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n"
+ }
+ ]
+ },
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
"type": "string",
"minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "maxLength": 4,
+ "example": 1234
},
- "TwnNm": {
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
@@ -10849,15 +11725,49 @@
"maxLength": 140,
"example": 12345
},
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "InstrForNxtAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForNextAgent1",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Instruction4Code",
+ "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "enum": [
+ "PHOA",
+ "TELA"
+ ],
+ "example": "PHOA"
},
- "DstrctNm": {
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
@@ -10865,218 +11775,166 @@
"maxLength": 140,
"example": 12345
},
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
+ ]
+ }
+ },
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
"type": "string",
"minLength": 1,
"maxLength": 4,
"example": 1234
},
- "Prtry": {
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
+ "Prtry"
+ ]
}
- },
+ ],
"example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
+ "Cd": "CH03"
}
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
+ }
+ ]
+ },
+ "RgltryRptg": {
+ "allOf": [
+ {
+ "title": "RegulatoryReporting3",
+ "description": "Information needed due to regulatory and/or statutory requirements.\n",
"type": "object",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "DbtCdtRptgInd": {
+ "allOf": [
+ {
+ "title": "RegulatoryReportingType1Code",
+ "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n",
+ "type": "string",
+ "enum": [
+ "CRED",
+ "DEBT",
+ "BOTH"
+ ],
+ "example": "BOTH"
+ },
+ {
+ "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n"
+ }
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "Authrty": {
+ "allOf": [
+ {
+ "title": "RegulatoryAuthority2",
+ "description": "Information about an entity requiring the regulatory reporting information.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "Issr": {
+ {
+ "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ }
+ },
+ {
+ "description": "Authority\n\nEntity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
+ "anyOf": [
+ {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -11084,609 +11942,524 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
]
- }
- ],
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
"example": {
- "Cd": "ADDR"
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "items": {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ "type": "array"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
}
},
"example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ "DbtCdtRptgInd": "CRED",
+ "Authrty": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ },
+ "Dtls": {
+ "Cd": "A1",
+ "Inf": "Mandatory regulatory information"
}
}
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ {
+ "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n"
}
- }
+ ]
},
- "DbtrAcct": {
- "description": "DebtorAccount\nAccount used to process a payment.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
+ "Tax": {
+ "allOf": [
+ {
+ "title": "TaxData1",
+ "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n",
"type": "object",
"properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "TaxParty1",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the creditor.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": 1111
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "Dbtr": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "CHQB"
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "UltmtDbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Issr": {
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -11694,147 +12467,108 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "ADDR"
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n"
+ }
+ ]
+ },
+ "AdmstnZone": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "DstrctNm": {
+ {
+ "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n"
+ }
+ ]
+ },
+ "RefNb": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
@@ -11842,57 +12576,14 @@
"maxLength": 140,
"example": 12345
},
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
+ "Mtd": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -11900,535 +12591,192 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ {
+ "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n"
+ }
+ ]
+ },
+ "TtlTaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
]
}
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Cd": "BIC"
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "TtlTaxAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "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.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
]
}
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Cd": "ADDR"
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "format": "date",
+ "example": "2013-03-07"
},
- "Ctry": {
- "title": "CountryCode",
+ {
+ "description": "Date\n\nDate by which tax is due.\n"
+ }
+ ]
+ },
+ "SeqNb": {
+ "allOf": [
+ {
+ "title": "Number",
"type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "pattern": "^[\\d\\-\\.\\,]{1,18}$",
+ "example": 256
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "SequenceNumber\n\nSequential number of the tax report.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ ]
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "Rcrd": {
+ "description": "Record\n\nDetails of the tax record.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Issr": {
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -12436,522 +12784,1826 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "BIC"
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ {
+ "items": {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
}
},
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ "AddtlInf": "VAT applicable"
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cdtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "Dbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "UltmtDbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "AdmstnZone": "CH",
+ "RefNb": 12345,
+ "Mtd": "A",
+ "TtlTaxblBaseAmt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "TtlTaxAmt": {
+ "Ccy": "CHF",
+ "Amt": 100
+ },
+ "Dt": "2018-01-01",
+ "SeqNb": 1,
+ "Rcrd": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "Tax\nProvides details on the tax.\n"
+ }
+ ]
+ },
+ "VrfctnOfTerms": {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
"type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
},
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IlpV4PrepPacket"
+ ]
+ },
+ {
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
},
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ {
+ "description": "SHA-256 signature of the terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Sh256Sgntr"
+ ]
+ }
+ ],
+ "example": {
+ "IlpV4PrepPacket": "1234567890ABCDEF"
+ }
+ }
+ },
+ "required": [
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "ChrgBr",
+ "Dbtr",
+ "DbtrAgt",
+ "CdtrAgt",
+ "Cdtr"
+ ],
+ "example": {
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
+ },
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ },
+ "SeqTp": "SEQTP"
+ },
+ "IntrBkSttlmAmt": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "InstdAmt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "XchgRate": 123.45,
+ "ChrgBr": "SHAR",
+ "ChrgsInf": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
+ },
+ "Dbtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "CODE"
+ },
+ "InstrForNxtAgt": {
+ "Cd": "CODE"
+ },
+ "Purp": {
+ "Cd": "CASH"
+ },
+ "RgltryRptg": {
+ "Dbtr": true,
+ "Cdtr": true
+ },
+ "Tax": "Cdtr"
+ }
+ },
+ "CreditTransferTransaction68": {
+ "title": "CreditTransferTransaction68",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
+ "type": "object",
+ "properties": {
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
+ "type": "object",
+ "properties": {
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
+ },
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
+ }
+ ]
+ },
+ "UETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
},
- "CtrySubDvsn": {
+ {
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -12959,2152 +14611,1743 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
}
},
+ "required": [
+ "TxId"
+ ],
"example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
}
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- }
+ ]
},
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "CHQB"
+ "Cd": "SEPA"
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "ADDR"
+ "Cd": "CH03"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "CASH"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
+ ]
}
},
"example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
},
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ "LclInstrm": {
+ "Cd": "CORE"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
+ "CtgyPurp": {
+ "Cd": "CASH"
}
}
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
+ {
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
+ }
+ ]
+ },
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
"type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
}
},
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
"example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
}
- }
+ ]
},
- "CdtrAcct": {
- "description": "CreditorAccount\nAccount to which a credit entry is made.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
]
}
- ],
+ },
+ "required": [],
"example": {
- "Cd": 1111
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "BrnchId": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ ]
}
},
"required": [
- "Id"
+ "FinInstnId"
],
"example": {
- "Tp": {
- "Cd": "IBAN"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "Id": 123
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
},
{
- "required": [
- "Sh256Sgntr"
- ]
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
}
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "Dbtr",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- }
- },
- "IntrBkSttlmAmt": {
- "Amount": 123.45,
- "Ccy": "EUR"
- },
- "Dbtr": {
- "Nm": "Debtor Name"
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "Creditor Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "INSTRUCTION"
- },
- "Purp": {
- "Cd": "CHAR"
- },
- "VrfctnOfTerms": {
- "Cntt": "CONTENT",
- "CnttTp": "PROPRIETARY"
- }
- }
- },
- "CryptographicLockChoice": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
]
},
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- },
- "DateAndPlaceOfBirth1": {
- "title": "DateAndPlaceOfBirth1",
- "description": "Details about date and place of birth of a person.\n",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "DatePeriod2": {
- "title": "DatePeriod2",
- "description": "Range of time defined by a start date and an end date.\n",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "ErrorCode": {
- "title": "ErrorCode",
- "type": "string",
- "pattern": "^[1-9]\\d{3}$",
- "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
- "example": "5100"
- },
- "ErrorDescription": {
- "title": "ErrorDescription",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "description": "Error description string."
- },
- "ErrorInformation": {
- "title": "ErrorInformation",
- "type": "object",
- "description": "Data model for the complex type ErrorInformation.",
- "properties": {
- "errorCode": {
- "title": "ErrorCode",
- "type": "string",
- "pattern": "^[1-9]\\d{3}$",
- "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
- "example": "5100"
- },
- "errorDescription": {
- "title": "ErrorDescription",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "description": "Error description string."
- },
- "extensionList": {
- "title": "ExtensionList",
- "type": "object",
- "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n",
- "properties": {
- "extension": {
- "type": "array",
- "items": {
- "title": "Extension",
- "type": "object",
- "description": "Data model for the complex type Extension.",
- "properties": {
- "key": {
- "title": "ExtensionKey",
- "type": "string",
- "minLength": 1,
- "maxLength": 32,
- "description": "Extension key."
- },
- "value": {
- "title": "ExtensionValue",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "description": "Extension value."
- }
- },
- "required": [
- "key",
- "value"
- ]
- },
- "minItems": 1,
- "maxItems": 16,
- "description": "Number of Extension elements."
- }
- },
- "required": [
- "extension"
- ]
- }
- },
- "required": [
- "errorCode",
- "errorDescription"
- ]
- },
- "ErrorInformationResponse": {
- "title": "ErrorInformationResponse",
- "type": "object",
- "description": "Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.\n",
- "properties": {
- "errorInformation": {
- "title": "ErrorInformation",
- "type": "object",
- "description": "Data model for the complex type ErrorInformation.",
- "properties": {
- "errorCode": {
- "title": "ErrorCode",
- "type": "string",
- "pattern": "^[1-9]\\d{3}$",
- "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
- "example": "5100"
- },
- "errorDescription": {
- "title": "ErrorDescription",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "description": "Error description string."
- },
- "extensionList": {
- "title": "ExtensionList",
- "type": "object",
- "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n",
- "properties": {
- "extension": {
- "type": "array",
- "items": {
- "title": "Extension",
- "type": "object",
- "description": "Data model for the complex type Extension.",
- "properties": {
- "key": {
- "title": "ExtensionKey",
- "type": "string",
- "minLength": 1,
- "maxLength": 32,
- "description": "Extension key."
- },
- "value": {
- "title": "ExtensionValue",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "description": "Extension value."
- }
- },
- "required": [
- "key",
- "value"
- ]
- },
- "minItems": 1,
- "maxItems": 16,
- "description": "Number of Extension elements."
- }
- },
- "required": [
- "extension"
- ]
- }
- },
- "required": [
- "errorCode",
- "errorDescription"
- ]
- }
- }
- },
- "Exact32HexBinaryText": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- },
- "Exact4AlphaNumericText": {
- "title": "Exact4AlphaNumericText",
- "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Execute_FIToFICustomerCreditTransferV13": {
- "title": "Execute_FIToFICustomerCreditTransferV13",
- "type": "object",
- "properties": {
- "GrpHdr": {
- "title": "GroupHeader129",
- "description": "Set of characteristics shared by all individual transactions included in the message.\n",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "PmtInstrXpryDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "NbOfTxs": {
- "title": "Max15NumericText",
- "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
- "type": "string",
- "pattern": "^[0-9]{1,15}$",
- "example": 123456789012345
- },
- "SttlmInf": {
- "title": "SettlementInstruction15",
- "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
+ "DbtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "SttlmMtd": {
- "description": "SettlementMethod\nMethod used to settle the (batch of) payment instructions.\n",
- "title": "SettlementMethod1Code",
- "type": "string",
- "enum": [
- "INDA",
- "INGA",
- "COVE",
- "CLRG"
- ],
- "example": "CLRG"
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
"oneOf": [
{
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
+ "IBAN"
]
},
{
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
+ "Othr"
]
}
],
"example": {
- "Cd": "SEPA"
+ "IBAN": "BE71096123456769"
}
},
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "CH03"
+ "Cd": "CACC"
}
},
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "CASH"
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
}
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
},
- "CtgyPurp": {
- "Cd": "CASH"
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- }
+ ]
}
},
- "required": [
- "SttlmMtd"
- ],
"example": {
- "SttlmMtd": "INDA",
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CH03"
- },
- "CtgyPurp": {
- "Cd": "SUPP"
- },
- "Cdtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "AdrLine": "Address",
- "Ctry": "CH"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN",
- "Issr": "BIC"
- }
- }
- }
- },
- "CtryOfRes": "CH",
- "CtctDtls": {
- "Nm": "Name",
- "PhneNb": 123,
- "EmailAdr": null
- }
- }
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
}
}
},
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction67",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
+ {
+ "description": "DebtorAccount\nAccount used to process a payment.\n"
+ }
+ ]
+ },
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n\n Set of elements used to further specify the type of transaction.\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n",
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "InstdAmt": {
- "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "XchgRate": {
- "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n",
- "title": "BaseOneRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 0.7
- },
- "ChrgBr": {
- "description": "ChargeBearer\nSpecifies which party/parties will bear the charges associated with the processing of the payment transaction.\n",
- "title": "ChargeBearerType1Code",
- "type": "string",
- "enum": [
- "DEBT",
- "CRED",
- "SHAR",
- "SLEV"
- ],
- "example": "DEBT"
- },
- "ChrgsInf": {
- "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction\n",
- "title": "Charges16",
- "type": "object",
- "properties": {
- "Amt": {
- "description": "Amount\n\n Transaction charges to be paid by the charge bearer.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Agt": {
- "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
+ "BICFI": {
+ "allOf": [
+ {
"title": "BICFIDec2014Identifier",
"type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
"pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
"example": "J5BMVH7D"
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
"title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
"type": "object",
"properties": {
"ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
},
- "Prtry": {
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
@@ -15117,91 +16360,149 @@
"MmbId": 123456789
}
},
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
"title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
"pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
"example": "529900T8BM49AURSDO55"
},
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
"minLength": 1,
"maxLength": 140,
"example": 12345
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
"AdrTp": {
"title": "AddressType3Choice",
"type": "object",
"description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
@@ -15211,14 +16512,6 @@
"Cd": "ADDR"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
"Dept": {
"title": "Max70Text",
"description": "Specifies a character string with a maximum length of 70 characters.\n",
@@ -15236,12 +16529,12 @@
"example": 1.2345678901234567e+99
},
"StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
"BldgNb": {
"title": "Max16Text",
@@ -15252,12 +16545,12 @@
"example": 1234567890123456
},
"BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
"Flr": {
"title": "Max70Text",
@@ -15267,14 +16560,6 @@
"maxLength": 70,
"example": 1.2345678901234567e+99
},
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
"PstBx": {
"title": "Max16Text",
"description": "Specifies a character string with a maximum length of 16 characters.\n",
@@ -15300,28 +16585,28 @@
"example": 1234567890123456
},
"TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
"TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
"DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
"CtrySubDvsn": {
"title": "Max35Text",
@@ -15349,14 +16634,12 @@
},
"example": {
"AdrTp": "ADDR",
- "CareOf": "CareOf",
"Dept": "Dept",
"SubDept": "SubDept",
"StrtNm": "StrtNm",
"BldgNb": "BldgNb",
"BldgNm": "BldgNm",
"Flr": "Flr",
- "UnitNb": "UnitNb",
"PstBx": "PstBx",
"Room": "Room",
"PstCd": "PstCd",
@@ -15368,64 +16651,108 @@
"AdrLine": "AdrLine"
}
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
"title": "GenericFinancialIdentification1",
"type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
"properties": {
"Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "SchemeName\nName of the identification scheme.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
+ ]
},
"Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
}
},
"required": [
@@ -15438,45 +16765,59 @@
},
"Issr": "BIC"
}
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
}
- }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -15484,14 +16825,28 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
"title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
"pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
"example": "529900T8BM49AURSDO55"
},
- "Nm": {
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
@@ -15499,76 +16854,120 @@
"maxLength": 140,
"example": 12345
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
"title": "PostalAddress27",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
"AdrTp": {
"title": "AddressType3Choice",
"type": "object",
"description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
@@ -15734,510 +17133,425 @@
"Ctry": "Ctry",
"AdrLine": "AdrLine"
}
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
+ ]
}
},
- "required": [
- "FinInstnId"
- ],
"example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
}
}
},
- "Tp": {
- "description": "Type\n\n Defines the type of charges.\n",
- "title": "ChargeType3Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCharge type, in a coded form.\n",
- "title": "ExternalChargeType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n",
- "title": "GenericIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "required": [
- "Amt",
- "Agt"
- ],
- "example": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
+ }
+ ]
+ },
+ "CdtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
"type": "string",
- "example": "ADDR"
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "MmbId"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
+ "LEI": {
+ "allOf": [
+ {
"title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
"pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
"example": "529900T8BM49AURSDO55"
},
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "AdrTp": {
+ "title": "AddressType3Choice",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
+ "description": "Choice of formats for the type of address.\n",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "ADDR"
}
},
- "Issr": {
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
},
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "PrvcOfBirth": {
+ "DstrctNm": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -16245,7 +17559,7 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "CityOfBirth": {
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -16253,84 +17567,143 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "CtryOfBirth": {
+ "Ctry": {
"title": "CountryCode",
"type": "string",
"pattern": "^[A-Z]{2,2}$",
"example": "US",
"description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
"example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
"type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
"properties": {
"Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "SchemeName\nName of the identification scheme.\n"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
+ ]
},
"Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
}
},
"required": [
@@ -16339,604 +17712,533 @@
"example": {
"Id": 123,
"SchmeNm": {
- "Cd": "DRLC"
+ "Cd": "IBAN"
},
"Issr": "BIC"
}
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
}
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
]
}
- ],
+ },
+ "required": [],
"example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
},
"Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
},
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "Issr": 123
}
}
},
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- }
+ ]
},
- "DbtrAcct": {
- "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
+ "Id": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
},
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
]
},
- {
- "required": [
- "Othr"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "PstlAdr": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "title": "PostalAddress27",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 5,
+ "maxLength": 140,
"example": 12345
},
- "Prtry": {
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
- {
- "required": [
- "Prtry"
- ]
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
- ],
+ },
"example": {
- "Cd": "CHQB"
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
+ }
+ ]
+ },
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
},
- "Issr": {
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -16944,43 +18246,44 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
+ },
+ "required": [
+ "MmbId"
],
"example": {
- "Cd": "ADDR"
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
}
},
- "CareOf": {
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
@@ -16988,234 +18291,395 @@
"maxLength": 140,
"example": 12345
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Prtry": {
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "BIC"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
+ ]
}
},
+ "required": [],
"example": {
"BICFI": "J5BMVH7D",
"ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
+ "ClrSysId": 1234,
+ "MmbId": 123
},
"LEI": 123,
"Nm": "Name",
@@ -17234,275 +18698,348 @@
"Othr": {
"Id": 123,
"SchmeNm": {
- "Cd": "CHQB"
+ "Cd": 123,
+ "Prtry": 123
},
"Issr": 123
}
}
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
"title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
"Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
},
"LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
},
"Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
},
"PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "allOf": [
+ {
+ "title": "PostalAddress27",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "AdrTp": {
+ "title": "AddressType3Choice",
"type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "Id",
- "Issr"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Cd": "ADDR"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
- {
- "required": [
- "Prtry"
- ]
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
- ],
+ },
"example": {
- "Cd": "ADDR"
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
}
},
"example": {
@@ -17514,789 +19051,447 @@
"Dept": "Department",
"SubDept": "Sub department",
"StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ "BldgNb": "Building number"
}
}
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
+ }
+ ]
+ },
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
"type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
"properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "IBAN": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "IBAN\nInternational 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.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "IBAN"
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
+ {
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
"type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
"properties": {
"Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
},
"SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "Id"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 4,
"example": 1234
},
- "Prtry": {
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
}
- },
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "EMAIL"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ "maxLength": 2048,
+ "example": 2048
},
- "Issr": "BIC"
- }
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
}
},
+ "required": [
+ "Id"
+ ],
"example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ "Tp": {
+ "Cd": "IBAN"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
+ "Id": 123
}
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
+ },
+ {
+ "description": "CreditorAccount\nAccount to which a credit entry is made.\n"
+ }
+ ]
+ },
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
}
- }
+ ]
},
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
+ "InstrInf": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
@@ -18304,198 +19499,56 @@
"maxLength": 140,
"example": 12345
},
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 4,
+ "example": 1234
},
- "CtrySubDvsn": {
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -18503,1054 +19556,860 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
{
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
}
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
+ }
+ ]
+ },
+ "VrfctnOfTerms": {
+ "allOf": [
+ {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
"type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
},
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
}
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
+ ]
}
},
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
+ "required": [
+ "IlpV4PrepPacket"
+ ]
},
- "CdtrAcct": {
- "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n",
- "title": "CashAccount40",
- "type": "object",
+ {
"properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
+ "Sh256Sgntr": {
+ "allOf": [
{
- "required": [
- "IBAN"
- ]
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
},
{
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "SHA-256 signature of the terms\n"
}
+ ]
+ }
+ },
+ "required": [
+ "Sh256Sgntr"
+ ]
+ }
+ ],
+ "example": {
+ "IlpV4PrepPacket": "1234567890ABCDEF"
+ }
+ },
+ {
+ "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "Dbtr",
+ "Cdtr"
+ ],
+ "example": {
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
+ },
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ }
+ },
+ "IntrBkSttlmAmt": {
+ "Amount": 123.45,
+ "Ccy": "EUR"
+ },
+ "Dbtr": {
+ "Nm": "Debtor Name"
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "Creditor Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "INSTRUCTION"
+ },
+ "Purp": {
+ "Cd": "CHAR"
+ },
+ "VrfctnOfTerms": {
+ "Cntt": "CONTENT",
+ "CnttTp": "PROPRIETARY"
+ }
+ }
+ },
+ "CryptographicLockChoice": {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
+ "type": "string",
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
+ },
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IlpV4PrepPacket"
+ ]
+ },
+ {
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "SHA-256 signature of the terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Sh256Sgntr"
+ ]
+ }
+ ],
+ "example": {
+ "IlpV4PrepPacket": "1234567890ABCDEF"
+ }
+ },
+ "DateAndPlaceOfBirth1": {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ "DatePeriod2": {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ "ErrorCode": {
+ "title": "ErrorCode",
+ "type": "string",
+ "pattern": "^[1-9]\\d{3}$",
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
+ "example": "5100"
+ },
+ "ErrorDescription": {
+ "title": "ErrorDescription",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "description": "Error description string."
+ },
+ "ErrorInformation": {
+ "title": "ErrorInformation",
+ "type": "object",
+ "description": "Data model for the complex type ErrorInformation.",
+ "properties": {
+ "errorCode": {
+ "title": "ErrorCode",
+ "type": "string",
+ "pattern": "^[1-9]\\d{3}$",
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
+ "example": "5100"
+ },
+ "errorDescription": {
+ "title": "ErrorDescription",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "description": "Error description string."
+ },
+ "extensionList": {
+ "title": "ExtensionList",
+ "type": "object",
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n",
+ "properties": {
+ "extension": {
+ "type": "array",
+ "items": {
+ "title": "Extension",
+ "type": "object",
+ "description": "Data model for the complex type Extension.",
+ "properties": {
+ "key": {
+ "title": "ExtensionKey",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 32,
+ "description": "Extension key."
+ },
+ "value": {
+ "title": "ExtensionValue",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "description": "Extension value."
+ }
+ },
+ "required": [
+ "key",
+ "value"
+ ]
+ },
+ "minItems": 1,
+ "maxItems": 16,
+ "description": "Number of Extension elements."
+ }
+ },
+ "required": [
+ "extension"
+ ]
+ }
+ },
+ "required": [
+ "errorCode",
+ "errorDescription"
+ ]
+ },
+ "ErrorInformationResponse": {
+ "title": "ErrorInformationResponse",
+ "type": "object",
+ "description": "Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.\n",
+ "properties": {
+ "errorInformation": {
+ "title": "ErrorInformation",
+ "type": "object",
+ "description": "Data model for the complex type ErrorInformation.",
+ "properties": {
+ "errorCode": {
+ "title": "ErrorCode",
+ "type": "string",
+ "pattern": "^[1-9]\\d{3}$",
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
+ "example": "5100"
+ },
+ "errorDescription": {
+ "title": "ErrorDescription",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "description": "Error description string."
+ },
+ "extensionList": {
+ "title": "ExtensionList",
+ "type": "object",
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n",
+ "properties": {
+ "extension": {
+ "type": "array",
+ "items": {
+ "title": "Extension",
+ "type": "object",
+ "description": "Data model for the complex type Extension.",
+ "properties": {
+ "key": {
+ "title": "ExtensionKey",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 32,
+ "description": "Extension key."
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
+ "value": {
+ "title": "ExtensionValue",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "description": "Extension value."
}
},
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
+ "required": [
+ "key",
+ "value"
+ ]
+ },
+ "minItems": 1,
+ "maxItems": 16,
+ "description": "Number of Extension elements."
+ }
+ },
+ "required": [
+ "extension"
+ ]
+ }
+ },
+ "required": [
+ "errorCode",
+ "errorDescription"
+ ]
+ }
+ }
+ },
+ "Exact32HexBinaryText": {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ "Exact4AlphaNumericText": {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ "Execute_FIToFICustomerCreditTransferV13": {
+ "title": "Execute_FIToFICustomerCreditTransferV13",
+ "type": "object",
+ "properties": {
+ "GrpHdr": {
+ "allOf": [
+ {
+ "title": "GroupHeader129",
+ "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n",
+ "type": "object",
+ "properties": {
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ {
+ "description": "Message Identification\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
},
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
+ {
+ "description": "Creation Date and Time\n"
+ }
+ ]
+ },
+ "PmtInstrXpryDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Payment Instruction Expiry Date and Time\n"
+ }
+ ]
+ },
+ "NbOfTxs": {
+ "allOf": [
+ {
+ "title": "Max15NumericText",
+ "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
+ "type": "string",
+ "pattern": "^[0-9]{1,15}$",
+ "example": 123456789012345
+ },
+ {
+ "description": "Number of Transactions\n"
+ }
+ ]
+ },
+ "SttlmInf": {
+ "allOf": [
+ {
+ "title": "SettlementInstruction15",
+ "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
"type": "object",
"properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
+ "SttlmMtd": {
+ "title": "SettlementMethod1Code",
+ "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n",
+ "type": "string",
+ "enum": [
+ "INDA",
+ "INGA",
+ "COVE",
+ "CLRG"
+ ],
+ "example": "CLRG"
+ },
+ "PmtTpInf": {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "InstrForNxtAgt": {
- "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForNextAgent1",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
- "title": "Instruction4Code",
- "type": "string",
- "enum": [
- "PHOA",
- "TELA"
- ],
- "example": "PHOA"
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone"
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "RgltryRptg": {
- "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n",
- "title": "RegulatoryReporting3",
- "type": "object",
- "properties": {
- "DbtCdtRptgInd": {
- "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "title": "RegulatoryReportingType1Code",
- "type": "string",
- "enum": [
- "CRED",
- "DEBT",
- "BOTH"
- ],
- "example": "BOTH"
- },
- "Authrty": {
- "description": "Authority\n\nEntity requiring the regulatory reporting information.\n",
- "title": "RegulatoryAuthority2",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "example": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- }
- },
- "Dtls": {
- "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "anyOf": [
- {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
},
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
},
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
+ "CtgyPurp": {
+ "allOf": [
{
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
},
{
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
}
]
}
},
"example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
},
- "Inf": 12345
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
}
- },
- {
- "items": {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ }
+ },
+ "required": [
+ "SttlmMtd"
+ ],
+ "example": {
+ "SttlmMtd": "INDA",
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CH03"
+ },
+ "CtgyPurp": {
+ "Cd": "SUPP"
+ },
+ "Cdtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "AdrLine": "Address",
+ "Ctry": "CH"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN",
+ "Issr": "BIC"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
}
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
+ }
+ },
+ "CtryOfRes": "CH",
+ "CtctDtls": {
+ "Nm": "Name",
+ "PhneNb": 123,
+ "EmailAdr": null
+ }
+ }
+ }
+ }
+ },
+ {
+ "description": "Settlement Information\n"
+ }
+ ]
+ },
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction67",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
+ "type": "object",
+ "properties": {
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
+ "type": "object",
+ "properties": {
+ "InstrId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -19558,2415 +20417,7180 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "type": "array"
- }
- ]
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
+ },
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
+ }
+ ]
+ },
+ "UETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "TxId"
+ ],
+ "example": {
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
}
},
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "DbtCdtRptgInd": "CRED",
- "Authrty": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- },
- "Dtls": {
- "Cd": "A1",
- "Inf": "Mandatory regulatory information"
- }
- }
- },
- "Tax": {
- "description": "Tax\nProvides details on the tax.\n",
- "title": "TaxData1",
- "type": "object",
- "properties": {
- "Cdtr": {
- "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n",
- "title": "TaxParty1",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT"
- }
- },
- "Dbtr": {
- "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
},
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "UltmtDbtr": {
- "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "AdmstnZone": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RefNb": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Mtd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TtlTaxblBaseAmt": {
- "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlTaxAmt": {
- "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dt": {
- "description": "Date\n\nDate by which tax is due.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "SeqNb": {
- "description": "SequenceNumber\n\nSequential number of the tax report\n",
- "title": "Number",
- "type": "string",
- "pattern": "^[\\d\\-\\.\\,]{1,18}$",
- "example": 256
- },
- "Rcrd": {
- "description": "Record\n\nDetails of the tax record.\n",
- "anyOf": [
- {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
+ "example": "HIGH"
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
"enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
],
- "example": "HLF1"
+ "example": "RTGS"
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
}
},
"example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
}
}
},
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
+ {
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
+ }
+ ]
+ },
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
"type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
"pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
"example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
"type": "string",
"pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
"example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
+ ]
+ }
+ },
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
+ }
+ ]
+ },
+ "InstdAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
"pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
"example": 123.45
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyCode",
"type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
"pattern": "^[A-Z]{3,3}$",
"example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n"
+ }
+ ]
+ },
+ "XchgRate": {
+ "allOf": [
+ {
+ "title": "BaseOneRate",
+ "type": "string",
+ "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 0.7
+ },
+ {
+ "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n"
+ }
+ ]
+ },
+ "ChrgBr": {
+ "title": "ChargeBearerType1Code",
+ "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n",
+ "type": "string",
+ "enum": [
+ "DEBT",
+ "CRED",
+ "SHAR",
+ "SLEV"
+ ],
+ "example": "DEBT"
+ },
+ "ChrgsInf": {
+ "allOf": [
+ {
+ "title": "Charges16",
+ "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n",
+ "type": "object",
+ "properties": {
+ "Amt": {
+ "allOf": [
{
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
"pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
"example": 123.45
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyCode",
"type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
"pattern": "^[A-Z]{3,3}$",
"example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
{
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
+ "description": "Amount\nTransaction charges to be paid by the charge bearer.\n"
+ }
+ ]
+ },
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
},
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
}
+ }
+ }
+ },
+ {
+ "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ChargeType3Choice",
+ "description": "ChargeType3Choice\nSpecifies the type of charge.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalChargeType1Code",
+ "description": "Specifies the type of charge applied to the transaction.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCharge type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification3",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n"
+ }
+ ]
}
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ "required": [
+ "Prtry"
+ ]
}
- },
- "type": "array"
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "Type\nDefines the type of charges.\n"
}
]
}
},
+ "required": [
+ "Amt",
+ "Agt"
+ ],
"example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
},
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
},
- "Inf": 12345
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
}
}
},
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n"
}
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
+ ]
},
- {
- "items": {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
}
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
+ ]
},
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
}
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
}
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ ]
}
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
+ "required": [
+ "OrgId"
+ ]
},
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
}
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
}
}
- },
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
"type": "object",
"properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
+ }
+ ]
+ },
+ "DbtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
}
},
"required": [
- "FrDt",
- "ToDt"
+ "Id"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
"type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
}
- },
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
"example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
+ },
+ {
+ "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n"
+ }
+ ]
+ },
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
}
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
}
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
"example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
}
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
}
- }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
},
- "type": "array"
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
},
- "Inf": 12345
- }
- }
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
},
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
+ }
+ ]
+ },
+ "CdtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
},
- "AddtlInf": "VAT applicable"
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
}
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Cdtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "Dbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "UltmtDbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "AdmstnZone": "CH",
- "RefNb": 12345,
- "Mtd": "A",
- "TtlTaxblBaseAmt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "TtlTaxAmt": {
- "Ccy": "CHF",
- "Amt": 100
- },
- "Dt": "2018-01-01",
- "SeqNb": 1,
- "Rcrd": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
- },
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "ChrgBr",
- "Dbtr",
- "DbtrAgt",
- "CdtrAgt",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- },
- "SeqTp": "SEQTP"
- },
- "IntrBkSttlmAmt": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "InstdAmt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "XchgRate": 123.45,
- "ChrgBr": "SHAR",
- "ChrgsInf": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- },
- "Dbtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "CODE"
- },
- "InstrForNxtAgt": {
- "Cd": "CODE"
- },
- "Purp": {
- "Cd": "CASH"
- },
- "RgltryRptg": {
- "Dbtr": true,
- "Cdtr": true
- },
- "Tax": "Cdtr"
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm",
- "NbOfTxs",
- "SttlmInf",
- "CdtTrfTxInf"
- ],
- "example": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "SttlmInf": {
- "SttlmMtd": "INDA",
- "SttlmAcct": {
- "Id": {
- "IBAN": 123
- }
- },
- "SttlmAcctOwnr": {
- "Nm": "John Doe"
- },
- "SttlmAcctSvcr": {
- "BICFI": 123
- }
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 123,
- "EndToEndId": 123
- },
- "PmtTpInf": {
- "InstrPrty": "NORM"
- },
- "InstdAmt": {
- "Amt": 123,
- "Ccy": "EUR"
- },
- "ChrgBr": "SLEV",
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": 123
- }
- },
- "Cdtr": {
- "Nm": "John Doe"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": 123
- }
- },
- "RmtInf": {
- "Ustrd": "Test"
- }
- }
- }
- },
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction67",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n\n Set of elements used to further specify the type of transaction.\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n",
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "InstdAmt": {
- "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "XchgRate": {
- "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n",
- "title": "BaseOneRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 0.7
- },
- "ChrgBr": {
- "description": "ChargeBearer\nSpecifies which party/parties will bear the charges associated with the processing of the payment transaction.\n",
- "title": "ChargeBearerType1Code",
- "type": "string",
- "enum": [
- "DEBT",
- "CRED",
- "SHAR",
- "SLEV"
- ],
- "example": "DEBT"
- },
- "ChrgsInf": {
- "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction\n",
- "title": "Charges16",
- "type": "object",
- "properties": {
- "Amt": {
- "description": "Amount\n\n Transaction charges to be paid by the charge bearer.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Agt": {
- "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ ]
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
}
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
},
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
}
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
}
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ }
+ },
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
+ }
+ ]
+ },
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "ADDR"
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
"type": "object",
"properties": {
"Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "InstrForNxtAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForNextAgent1",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Instruction4Code",
+ "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n",
+ "type": "string",
+ "enum": [
+ "PHOA",
+ "TELA"
+ ],
+ "example": "PHOA"
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "BIC"
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
},
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
+ }
+ ]
},
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "RgltryRptg": {
+ "allOf": [
+ {
+ "title": "RegulatoryReporting3",
+ "description": "Information needed due to regulatory and/or statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "DbtCdtRptgInd": {
+ "allOf": [
+ {
+ "title": "RegulatoryReportingType1Code",
+ "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n",
+ "type": "string",
+ "enum": [
+ "CRED",
+ "DEBT",
+ "BOTH"
+ ],
+ "example": "BOTH"
+ },
+ {
+ "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n"
+ }
+ ]
+ },
+ "Authrty": {
+ "allOf": [
+ {
+ "title": "RegulatoryAuthority2",
+ "description": "Information about an entity requiring the regulatory reporting information.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ }
+ },
+ {
+ "description": "Authority\n\nEntity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
+ "anyOf": [
+ {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ {
+ "items": {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DbtCdtRptgInd": "CRED",
+ "Authrty": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ },
+ "Dtls": {
+ "Cd": "A1",
+ "Inf": "Mandatory regulatory information"
+ }
+ }
+ },
+ {
+ "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n"
+ }
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "Tax": {
+ "allOf": [
+ {
+ "title": "TaxData1",
+ "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "TaxParty1",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the creditor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT"
+ }
+ },
+ {
+ "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
},
- "Issr": {
+ {
+ "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n"
+ }
+ ]
+ },
+ "UltmtDbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
+ },
+ {
+ "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n"
+ }
+ ]
+ },
+ "AdmstnZone": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -21974,155 +27598,2120 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n"
+ }
+ ]
+ },
+ "RefNb": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n"
+ }
+ ]
+ },
+ "Mtd": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "TtlTaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ },
+ "TtlTaxAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate by which tax is due.\n"
+ }
+ ]
+ },
+ "SeqNb": {
+ "allOf": [
+ {
+ "title": "Number",
+ "type": "string",
+ "pattern": "^[\\d\\-\\.\\,]{1,18}$",
+ "example": 256
+ },
+ {
+ "description": "SequenceNumber\n\nSequential number of the tax report.\n"
+ }
+ ]
+ },
+ "Rcrd": {
+ "description": "Record\n\nDetails of the tax record.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cdtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "Dbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "UltmtDbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "AdmstnZone": "CH",
+ "RefNb": 12345,
+ "Mtd": "A",
+ "TtlTaxblBaseAmt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "TtlTaxAmt": {
+ "Ccy": "CHF",
+ "Amt": 100
+ },
+ "Dt": "2018-01-01",
+ "SeqNb": 1,
+ "Rcrd": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
},
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ {
+ "description": "Tax\nProvides details on the tax.\n"
+ }
+ ]
+ },
+ "VrfctnOfTerms": {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
+ "type": "string",
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
+ },
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IlpV4PrepPacket"
+ ]
},
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "SHA-256 signature of the terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Sh256Sgntr"
+ ]
+ }
+ ],
+ "example": {
+ "IlpV4PrepPacket": "1234567890ABCDEF"
+ }
+ }
+ },
+ "required": [
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "ChrgBr",
+ "Dbtr",
+ "DbtrAgt",
+ "CdtrAgt",
+ "Cdtr"
+ ],
+ "example": {
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
+ },
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ },
+ "SeqTp": "SEQTP"
+ },
+ "IntrBkSttlmAmt": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "InstdAmt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "XchgRate": 123.45,
+ "ChrgBr": "SHAR",
+ "ChrgsInf": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
},
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
+ },
+ "Dbtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "CODE"
+ },
+ "InstrForNxtAgt": {
+ "Cd": "CODE"
+ },
+ "Purp": {
+ "Cd": "CASH"
+ },
+ "RgltryRptg": {
+ "Dbtr": true,
+ "Cdtr": true
+ },
+ "Tax": "Cdtr"
+ }
+ },
+ {
+ "description": "Credit Transfer Transaction Information\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MsgId",
+ "CreDtTm",
+ "NbOfTxs",
+ "SttlmInf",
+ "CdtTrfTxInf"
+ ],
+ "example": {
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "SttlmInf": {
+ "SttlmMtd": "INDA",
+ "SttlmAcct": {
+ "Id": {
+ "IBAN": 123
+ }
+ },
+ "SttlmAcctOwnr": {
+ "Nm": "John Doe"
+ },
+ "SttlmAcctSvcr": {
+ "BICFI": 123
+ }
+ },
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": 123,
+ "EndToEndId": 123
+ },
+ "PmtTpInf": {
+ "InstrPrty": "NORM"
+ },
+ "InstdAmt": {
+ "Amt": 123,
+ "Ccy": "EUR"
+ },
+ "ChrgBr": "SLEV",
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": 123
+ }
+ },
+ "Cdtr": {
+ "Nm": "John Doe"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": 123
+ }
+ },
+ "RmtInf": {
+ "Ustrd": "Test"
+ }
+ }
+ }
+ },
+ {
+ "description": "Group Header\nSet of characteristics shared by all individual transactions included in the message.\n"
+ }
+ ]
+ },
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction67",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
+ "type": "object",
+ "properties": {
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
+ "type": "object",
+ "properties": {
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
+ },
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
+ }
+ ]
+ },
+ "UETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
},
- "CtrySubDvsn": {
+ {
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -22130,3859 +29719,5091 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Tp": {
- "description": "Type\n\n Defines the type of charges.\n",
- "title": "ChargeType3Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCharge type, in a coded form.\n",
- "title": "ExternalChargeType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n",
- "title": "GenericIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
+ "TxId"
],
"example": {
- "Id": 123,
- "Issr": "BIC"
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "required": [
- "Amt",
- "Agt"
- ],
- "example": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- }
- },
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
+ "enum": [
+ "HIGH",
+ "NORM"
],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "example": "HIGH"
},
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
},
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "SEPA"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "CCPT"
+ "Cd": "CH03"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
},
- "Issr": "BIC"
- }
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
}
},
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
}
}
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
},
{
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
}
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
},
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
"required": [
- "ChanlTp"
+ "ActiveCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
}
- }
+ ]
},
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "DbtrAcct": {
- "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
+ "InstdAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "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.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Ccy": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
},
{
- "required": [
- "Othr"
- ]
+ "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n"
}
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
+ ]
},
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "XchgRate": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "BaseOneRate",
+ "type": "string",
+ "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 0.7
},
{
- "required": [
- "Prtry"
- ]
+ "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n"
}
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ ]
},
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "ChrgBr": {
+ "title": "ChargeBearerType1Code",
+ "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
+ "enum": [
+ "DEBT",
+ "CRED",
+ "SHAR",
+ "SLEV"
],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
+ "example": "DEBT"
},
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
+ "ChrgsInf": {
+ "allOf": [
+ {
+ "title": "Charges16",
+ "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n",
"type": "object",
"properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "Amt": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Amount\nTransaction charges to be paid by the charge bearer.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "Agt": {
+ "allOf": [
{
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ChargeType3Choice",
+ "description": "ChargeType3Choice\nSpecifies the type of charge.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalChargeType1Code",
+ "description": "Specifies the type of charge applied to the transaction.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCharge type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification3",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "Type\nDefines the type of charges.\n"
+ }
+ ]
}
},
"required": [
- "Id"
+ "Amt",
+ "Agt"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
},
- "Issr": "BIC"
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
}
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
+ {
+ "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n"
}
- }
+ ]
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "example": "ADDR"
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "SchmeNm": {
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Id": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
},
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
},
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "CtctDtls": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "MmbId"
+ "Id"
],
"example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
},
- "MmbId": 123456789
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
}
},
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ {
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
+ }
+ ]
+ },
+ "DbtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
"type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
}
- },
- "required": [
- "Id",
- "Issr"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "IBAN": "BE71096123456769"
}
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Tp": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Prxy": {
+ "allOf": [
{
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
- "required": [
- "Id"
- ],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "Issr": "BIC"
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
+ {
+ "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n"
}
- }
+ ]
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
}
},
+ "required": [
+ "FinInstnId"
+ ],
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
+ },
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
}
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
+ "CdtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
]
}
- ],
+ },
+ "required": [],
"example": {
- "Cd": "BIC"
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "CCPT"
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
+ "required": [
+ "FinInstnId"
+ ],
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "Othr": {
+ "BrnchId": {
"Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
}
}
}
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
},
{
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
}
- }
+ ]
},
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "CdtrAcct": {
- "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "maxLength": 140,
+ "example": 12345
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
}
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "InstrForNxtAgt": {
- "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForNextAgent1",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
- "title": "Instruction4Code",
- "type": "string",
- "enum": [
- "PHOA",
- "TELA"
- ],
- "example": "PHOA"
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone"
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "RgltryRptg": {
- "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n",
- "title": "RegulatoryReporting3",
- "type": "object",
- "properties": {
- "DbtCdtRptgInd": {
- "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "title": "RegulatoryReportingType1Code",
- "type": "string",
- "enum": [
- "CRED",
- "DEBT",
- "BOTH"
- ],
- "example": "BOTH"
- },
- "Authrty": {
- "description": "Authority\n\nEntity requiring the regulatory reporting information.\n",
- "title": "RegulatoryAuthority2",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "example": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- }
- },
- "Dtls": {
- "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "anyOf": [
- {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
+ "PstlAdr": {
+ "allOf": [
{
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- },
- {
- "items": {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -25990,33879 +34811,1411 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "type": "array"
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
- ]
- }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
},
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "DbtCdtRptgInd": "CRED",
- "Authrty": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- },
- "Dtls": {
- "Cd": "A1",
- "Inf": "Mandatory regulatory information"
- }
- }
- },
- "Tax": {
- "description": "Tax\nProvides details on the tax.\n",
- "title": "TaxData1",
- "type": "object",
- "properties": {
- "Cdtr": {
- "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n",
- "title": "TaxParty1",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT"
- }
- },
- "Dbtr": {
- "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "UltmtDbtr": {
- "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "AdmstnZone": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RefNb": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Mtd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TtlTaxblBaseAmt": {
- "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlTaxAmt": {
- "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dt": {
- "description": "Date\n\nDate by which tax is due.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "SeqNb": {
- "description": "SequenceNumber\n\nSequential number of the tax report\n",
- "title": "Number",
- "type": "string",
- "pattern": "^[\\d\\-\\.\\,]{1,18}$",
- "example": 256
- },
- "Rcrd": {
- "description": "Record\n\nDetails of the tax record.\n",
- "anyOf": [
- {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
"type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
+ "oneOf": [
{
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
"type": "object",
"properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
}
},
- "required": [
- "FrDt",
- "ToDt"
- ],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
+ "OrgId"
+ ]
},
{
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
}
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
}
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ ]
}
},
- "type": "array"
+ "required": [
+ "PrvtId"
+ ]
}
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
- },
- {
- "items": {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
}
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
}
},
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
}
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
},
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
}
- },
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
"type": "object",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
"type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
}
- }
+ ]
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
+ "ChanlTp"
],
"example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ "ChanlTp": "PHON",
+ "Id": 1234567890
}
},
- "type": "array"
- }
- ]
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
}
},
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
}
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
},
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
}
},
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
}
- },
- "type": "array"
+ }
+ },
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
}
]
- }
- },
- "example": {
- "Cdtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "Dbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "UltmtDbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "AdmstnZone": "CH",
- "RefNb": 12345,
- "Mtd": "A",
- "TtlTaxblBaseAmt": {
- "Ccy": "CHF",
- "Amt": 1000
},
- "TtlTaxAmt": {
- "Ccy": "CHF",
- "Amt": 100
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
+ },
+ {
+ "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n"
+ }
+ ]
},
- "Dt": "2018-01-01",
- "SeqNb": 1,
- "Rcrd": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
},
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
+ "InstrForNxtAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForNextAgent1",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Instruction4Code",
+ "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n",
+ "type": "string",
+ "enum": [
+ "PHOA",
+ "TELA"
+ ],
+ "example": "PHOA"
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
]
},
- {
- "required": [
- "Sh256Sgntr"
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
+ }
]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "ChrgBr",
- "Dbtr",
- "DbtrAgt",
- "CdtrAgt",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- },
- "SeqTp": "SEQTP"
- },
- "IntrBkSttlmAmt": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "InstdAmt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "XchgRate": 123.45,
- "ChrgBr": "SHAR",
- "ChrgsInf": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
},
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- },
- "Dbtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "CODE"
- },
- "InstrForNxtAgt": {
- "Cd": "CODE"
- },
- "Purp": {
- "Cd": "CASH"
- },
- "RgltryRptg": {
- "Dbtr": true,
- "Cdtr": true
- },
- "Tax": "Cdtr"
- }
- }
- },
- "required": [
- "GrpHdr",
- "CdtTrfTxInf"
- ],
- "example": {
- "GrpHdr": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "SttlmInf": {
- "SttlmMtd": "INDA",
- "SttlmAcct": {
- "Id": {
- "IBAN": 123
- }
- },
- "SttlmAcctOwnr": {
- "Nm": "John Doe"
- },
- "SttlmAcctSvcr": {
- "BICFI": 123
- }
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 123,
- "EndToEndId": 123
- },
- "PmtTpInf": {
- "InstrPrty": "NORM"
- },
- "InstdAmt": {
- "Amt": 123,
- "Ccy": "EUR"
- },
- "ChrgBr": "SLEV",
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": 123
- }
- },
- "Cdtr": {
- "Nm": "John Doe"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": 123
- }
- },
- "RmtInf": {
- "Ustrd": "Test"
- }
- }
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 123,
- "EndToEndId": 123
- },
- "PmtTpInf": {
- "InstrPrty": "NORM"
- },
- "InstdAmt": {
- "Amt": 123,
- "Ccy": "EUR"
- },
- "ChrgBr": "SLEV",
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": 123
- }
- },
- "Cdtr": {
- "Nm": "John Doe"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": 123
- }
- },
- "RmtInf": {
- "Ustrd": "Test"
- }
- }
- }
- },
- "Extension": {
- "title": "Extension",
- "type": "object",
- "description": "Data model for the complex type Extension.",
- "properties": {
- "key": {
- "title": "ExtensionKey",
- "type": "string",
- "minLength": 1,
- "maxLength": 32,
- "description": "Extension key."
- },
- "value": {
- "title": "ExtensionValue",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "description": "Extension value."
- }
- },
- "required": [
- "key",
- "value"
- ]
- },
- "ExtensionKey": {
- "title": "ExtensionKey",
- "type": "string",
- "minLength": 1,
- "maxLength": 32,
- "description": "Extension key."
- },
- "ExtensionList": {
- "title": "ExtensionList",
- "type": "object",
- "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n",
- "properties": {
- "extension": {
- "type": "array",
- "items": {
- "title": "Extension",
- "type": "object",
- "description": "Data model for the complex type Extension.",
- "properties": {
- "key": {
- "title": "ExtensionKey",
- "type": "string",
- "minLength": 1,
- "maxLength": 32,
- "description": "Extension key."
- },
- "value": {
- "title": "ExtensionValue",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "description": "Extension value."
- }
- },
- "required": [
- "key",
- "value"
- ]
- },
- "minItems": 1,
- "maxItems": 16,
- "description": "Number of Extension elements."
- }
- },
- "required": [
- "extension"
- ]
- },
- "ExtensionValue": {
- "title": "ExtensionValue",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "description": "Extension value."
- },
- "ExternalAccountIdentification1Code": {
- "title": "ExternalAccountIdentification1Code",
- "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalCashAccountType1Code": {
- "title": "ExternalCashAccountType1Code",
- "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalCategoryPurpose1Code": {
- "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "ExternalChargeType1Code": {
- "title": "ExternalChargeType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalClearingSystemIdentification1Code": {
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "ExternalCreditorAgentInstruction1Code": {
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalFinancialInstitutionIdentification1Code": {
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalLocalInstrument1Code": {
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "ExternalOrganisationIdentification1Code": {
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalPaymentTransactionStatus1Code": {
- "title": "ExternalPaymentTransactionStatus1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalPersonIdentification1Code": {
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalProxyAccountType1Code": {
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalPurpose1Code": {
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalServiceLevel1Code": {
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalStatusReason1Code": {
- "title": "ExternalStatusReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "ExternalVerificationReason1Code": {
- "title": "ExternalVerificationReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "FinancialIdentificationSchemeName1Choice": {
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "FinancialInstitutionIdentification18": {
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
- }
- },
- "FinancialInstitutionIdentification23": {
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "FxRequest_FICreditTransferProposal": {
- "title": "FxRequest_FICreditTransferProposal",
- "type": "object",
- "properties": {
- "GrpHdr": {
- "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n",
- "title": "GroupHeader113",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "NbOfTxs": {
- "title": "Max15NumericText",
- "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
- "type": "string",
- "pattern": "^[0-9]{1,15}$",
- "example": 123456789012345
- },
- "TtlIntrBkSttlmAmt": {
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "SttlmInf": {
- "title": "SettlementInstruction15",
- "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
- "type": "object",
- "properties": {
- "SttlmMtd": {
- "description": "SettlementMethod\nMethod used to settle the (batch of) payment instructions.\n",
- "title": "SettlementMethod1Code",
- "type": "string",
- "enum": [
- "INDA",
- "INGA",
- "COVE",
- "CLRG"
- ],
- "example": "CLRG"
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- }
- },
- "required": [
- "SttlmMtd"
- ],
- "example": {
- "SttlmMtd": "INDA",
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CH03"
- },
- "CtgyPurp": {
- "Cd": "SUPP"
- },
- "Cdtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "AdrLine": "Address",
- "Ctry": "CH"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN",
- "Issr": "BIC"
- }
- }
- }
- },
- "CtryOfRes": "CH",
- "CtctDtls": {
- "Nm": "Name",
- "PhneNb": 123,
- "EmailAdr": null
- }
- }
- }
- }
- },
- "PmtTpInf": {
- "title": "PaymentTypeInformation28",
- "description": "Provides further details of the type of payment.\n",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction68",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "title": "PaymentTypeInformation28",
- "description": "Provides further details of the type of payment.\n",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "DbtrAcct": {
- "description": "DebtorAccount\nAccount used to process a payment.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAcct": {
- "description": "CreditorAccount\nAccount to which a credit entry is made.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
- },
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "Dbtr",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- }
- },
- "IntrBkSttlmAmt": {
- "Amount": 123.45,
- "Ccy": "EUR"
- },
- "Dbtr": {
- "Nm": "Debtor Name"
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "Creditor Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "INSTRUCTION"
- },
- "Purp": {
- "Cd": "CHAR"
- },
- "VrfctnOfTerms": {
- "Cntt": "CONTENT",
- "CnttTp": "PROPRIETARY"
- }
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm",
- "NbOfTxs",
- "SttlmInf",
- "CdtTrfTxInf"
- ],
- "example": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "TtlIntrBkSttlmAmt": {
- "Ccy": "EUR",
- "Value": 100
- },
- "SttlmInf": {
- "SttlmMtd": "INDA",
- "SttlmAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "SttlmAcctOwnr": {
- "Nm": "Name"
- },
- "SttlmAcctSvcr": {
- "Nm": "Name"
- },
- "SttlmAgt": {
- "FinInstnId": {
- "BICFI": "BIC"
- }
- }
- },
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "CtgyPurp": "CASH"
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 12345,
- "EndToEndId": 12345
- },
- "Amt": {
- "InstdAmt": {
- "Ccy": "EUR",
- "Value": 100
- }
- },
- "Cdtr": {
- "Nm": "Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "BIC"
- }
- },
- "CdtrAgtAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "RmtInf": {
- "Ustrd": "Test"
- }
- }
- }
- }
- },
- "required": [
- "GrpHdr"
- ],
- "example": {
- "GrpHdr": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "TtlIntrBkSttlmAmt": {
- "Ccy": "EUR",
- "Value": 100
- },
- "SttlmInf": {
- "SttlmMtd": "INDA",
- "SttlmAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "SttlmAcctOwnr": {
- "Nm": "Name"
- },
- "SttlmAcctSvcr": {
- "Nm": "Name"
- },
- "SttlmAgt": {
- "FinInstnId": {
- "BICFI": "BIC"
- }
- }
- },
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "CtgyPurp": "CASH"
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 12345,
- "EndToEndId": 12345
- },
- "Amt": {
- "InstdAmt": {
- "Ccy": "EUR",
- "Value": 100
- }
- },
- "Cdtr": {
- "Nm": "Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "BIC"
- }
- },
- "Dbtr": {
- "Nm": "Name"
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "DbtrAgt": {
- "FinInstnId": {
- "BICFI": "BIC"
- }
- },
- "IntrBkSttlmAmt": {
- "Ccy": "EUR",
- "Value": 100
- },
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- },
- "RgltryRptg": {
- "Dbtr": {
- "Nm": "Name"
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "DbtrAgt": {
- "FinInstnId": {
- "BICFI": "BIC"
- }
- },
- "Cdtr": {
- "Nm": "Name"
- }
- }
- }
- }
- }
- },
- "FxResponse_FICreditTransferConfirmation": {
- "title": "FxResponse_FICreditTransferConfirmation",
- "type": "object",
- "properties": {
- "GrpHdr": {
- "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n",
- "title": "GroupHeader113",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "NbOfTxs": {
- "title": "Max15NumericText",
- "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
- "type": "string",
- "pattern": "^[0-9]{1,15}$",
- "example": 123456789012345
- },
- "TtlIntrBkSttlmAmt": {
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "SttlmInf": {
- "title": "SettlementInstruction15",
- "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
- "type": "object",
- "properties": {
- "SttlmMtd": {
- "description": "SettlementMethod\nMethod used to settle the (batch of) payment instructions.\n",
- "title": "SettlementMethod1Code",
- "type": "string",
- "enum": [
- "INDA",
- "INGA",
- "COVE",
- "CLRG"
- ],
- "example": "CLRG"
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- }
- },
- "required": [
- "SttlmMtd"
- ],
- "example": {
- "SttlmMtd": "INDA",
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CH03"
- },
- "CtgyPurp": {
- "Cd": "SUPP"
- },
- "Cdtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "AdrLine": "Address",
- "Ctry": "CH"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN",
- "Issr": "BIC"
- }
- }
- }
- },
- "CtryOfRes": "CH",
- "CtctDtls": {
- "Nm": "Name",
- "PhneNb": 123,
- "EmailAdr": null
- }
- }
- }
- }
- },
- "PmtTpInf": {
- "title": "PaymentTypeInformation28",
- "description": "Provides further details of the type of payment.\n",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction68",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "title": "PaymentTypeInformation28",
- "description": "Provides further details of the type of payment.\n",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "DbtrAcct": {
- "description": "DebtorAccount\nAccount used to process a payment.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAcct": {
- "description": "CreditorAccount\nAccount to which a credit entry is made.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
- },
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "Dbtr",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- }
- },
- "IntrBkSttlmAmt": {
- "Amount": 123.45,
- "Ccy": "EUR"
- },
- "Dbtr": {
- "Nm": "Debtor Name"
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "Creditor Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "INSTRUCTION"
- },
- "Purp": {
- "Cd": "CHAR"
- },
- "VrfctnOfTerms": {
- "Cntt": "CONTENT",
- "CnttTp": "PROPRIETARY"
- }
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm",
- "NbOfTxs",
- "SttlmInf",
- "CdtTrfTxInf"
- ],
- "example": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "TtlIntrBkSttlmAmt": {
- "Ccy": "EUR",
- "Value": 100
- },
- "SttlmInf": {
- "SttlmMtd": "INDA",
- "SttlmAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "SttlmAcctOwnr": {
- "Nm": "Name"
- },
- "SttlmAcctSvcr": {
- "Nm": "Name"
- },
- "SttlmAgt": {
- "FinInstnId": {
- "BICFI": "BIC"
- }
- }
- },
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "CtgyPurp": "CASH"
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 12345,
- "EndToEndId": 12345
- },
- "Amt": {
- "InstdAmt": {
- "Ccy": "EUR",
- "Value": 100
- }
- },
- "Cdtr": {
- "Nm": "Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "BIC"
- }
- },
- "CdtrAgtAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "RmtInf": {
- "Ustrd": "Test"
- }
- }
- }
- },
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction68",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "title": "PaymentTypeInformation28",
- "description": "Provides further details of the type of payment.\n",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "DbtrAcct": {
- "description": "DebtorAccount\nAccount used to process a payment.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAcct": {
- "description": "CreditorAccount\nAccount to which a credit entry is made.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
- },
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "Dbtr",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- }
- },
- "IntrBkSttlmAmt": {
- "Amount": 123.45,
- "Ccy": "EUR"
- },
- "Dbtr": {
- "Nm": "Debtor Name"
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "Creditor Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "INSTRUCTION"
- },
- "Purp": {
- "Cd": "CHAR"
- },
- "VrfctnOfTerms": {
- "Cntt": "CONTENT",
- "CnttTp": "PROPRIETARY"
- }
- }
- }
- },
- "required": [
- "GrpHdr",
- "CdtTrfTxInf"
- ],
- "example": {
- "GrpHdr": {
- "MsgId": "20191122-123456",
- "CreDtTm": "2019-11-22T12:34:56",
- "NbOfTxs": 1,
- "CtrlSum": 100,
- "InitgPty": {
- "Nm": "Initiating Party Name"
- },
- "MsgRcpt": {
- "Nm": "Message Recipient Name"
- }
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": "20191122-123456",
- "EndToEndId": "20191122-123456"
- },
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "CtgyPurp": "SUPP"
- },
- "IntrBkSttlmAmt": {
- "Amt": 100,
- "Ccy": "EUR"
- },
- "ChrgBr": "SLEV",
- "Cdtr": {
- "Nm": "Creditor Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account"
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "BNBABEBB"
- }
- },
- "CdtrAgtAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account"
- },
- "Dbtr": {
- "Nm": "Debtor Name"
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account"
- },
- "DbtrAgt": {
- "FinInstnId": {
- "BICFI": "BNBABEBB"
- }
- },
- "DbtrAgtAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account"
- },
- "RmtInf": {
- "Ustrd": "Remittance Information"
- },
- "RgltryRptg": {
- "Dbtr": {
- "Nm": "Debtor Name"
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account"
- }
- }
- }
- }
- },
- "Fxecute_FinancialInstitutionCreditTransferV12": {
- "title": "Fxecute_FinancialInstitutionCreditTransferV12",
- "type": "object",
- "properties": {
- "GrpHdr": {
- "title": "GroupHeader129",
- "description": "Set of characteristics shared by all individual transactions included in the message.\n",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "PmtInstrXpryDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "NbOfTxs": {
- "title": "Max15NumericText",
- "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
- "type": "string",
- "pattern": "^[0-9]{1,15}$",
- "example": 123456789012345
- },
- "SttlmInf": {
- "title": "SettlementInstruction15",
- "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
- "type": "object",
- "properties": {
- "SttlmMtd": {
- "description": "SettlementMethod\nMethod used to settle the (batch of) payment instructions.\n",
- "title": "SettlementMethod1Code",
- "type": "string",
- "enum": [
- "INDA",
- "INGA",
- "COVE",
- "CLRG"
- ],
- "example": "CLRG"
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- }
- },
- "required": [
- "SttlmMtd"
- ],
- "example": {
- "SttlmMtd": "INDA",
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CH03"
- },
- "CtgyPurp": {
- "Cd": "SUPP"
- },
- "Cdtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "AdrLine": "Address",
- "Ctry": "CH"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN",
- "Issr": "BIC"
- }
- }
- }
- },
- "CtryOfRes": "CH",
- "CtctDtls": {
- "Nm": "Name",
- "PhneNb": 123,
- "EmailAdr": null
- }
- }
- }
- }
- },
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction67",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n\n Set of elements used to further specify the type of transaction.\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n",
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "InstdAmt": {
- "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "XchgRate": {
- "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n",
- "title": "BaseOneRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 0.7
- },
- "ChrgBr": {
- "description": "ChargeBearer\nSpecifies which party/parties will bear the charges associated with the processing of the payment transaction.\n",
- "title": "ChargeBearerType1Code",
- "type": "string",
- "enum": [
- "DEBT",
- "CRED",
- "SHAR",
- "SLEV"
- ],
- "example": "DEBT"
- },
- "ChrgsInf": {
- "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction\n",
- "title": "Charges16",
- "type": "object",
- "properties": {
- "Amt": {
- "description": "Amount\n\n Transaction charges to be paid by the charge bearer.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Agt": {
- "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Tp": {
- "description": "Type\n\n Defines the type of charges.\n",
- "title": "ChargeType3Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCharge type, in a coded form.\n",
- "title": "ExternalChargeType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n",
- "title": "GenericIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "required": [
- "Amt",
- "Agt"
- ],
- "example": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- }
- },
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "DbtrAcct": {
- "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "CdtrAcct": {
- "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "InstrForNxtAgt": {
- "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForNextAgent1",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
- "title": "Instruction4Code",
- "type": "string",
- "enum": [
- "PHOA",
- "TELA"
- ],
- "example": "PHOA"
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone"
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "RgltryRptg": {
- "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n",
- "title": "RegulatoryReporting3",
- "type": "object",
- "properties": {
- "DbtCdtRptgInd": {
- "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "title": "RegulatoryReportingType1Code",
- "type": "string",
- "enum": [
- "CRED",
- "DEBT",
- "BOTH"
- ],
- "example": "BOTH"
- },
- "Authrty": {
- "description": "Authority\n\nEntity requiring the regulatory reporting information.\n",
- "title": "RegulatoryAuthority2",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "example": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- }
- },
- "Dtls": {
- "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "anyOf": [
- {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- },
- {
- "items": {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "DbtCdtRptgInd": "CRED",
- "Authrty": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- },
- "Dtls": {
- "Cd": "A1",
- "Inf": "Mandatory regulatory information"
- }
- }
- },
- "Tax": {
- "description": "Tax\nProvides details on the tax.\n",
- "title": "TaxData1",
- "type": "object",
- "properties": {
- "Cdtr": {
- "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n",
- "title": "TaxParty1",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT"
- }
- },
- "Dbtr": {
- "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "UltmtDbtr": {
- "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "AdmstnZone": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RefNb": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Mtd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TtlTaxblBaseAmt": {
- "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlTaxAmt": {
- "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dt": {
- "description": "Date\n\nDate by which tax is due.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "SeqNb": {
- "description": "SequenceNumber\n\nSequential number of the tax report\n",
- "title": "Number",
- "type": "string",
- "pattern": "^[\\d\\-\\.\\,]{1,18}$",
- "example": 256
- },
- "Rcrd": {
- "description": "Record\n\nDetails of the tax record.\n",
- "anyOf": [
- {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
- },
- {
- "items": {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Cdtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "Dbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "UltmtDbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "AdmstnZone": "CH",
- "RefNb": 12345,
- "Mtd": "A",
- "TtlTaxblBaseAmt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "TtlTaxAmt": {
- "Ccy": "CHF",
- "Amt": 100
- },
- "Dt": "2018-01-01",
- "SeqNb": 1,
- "Rcrd": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
- },
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "ChrgBr",
- "Dbtr",
- "DbtrAgt",
- "CdtrAgt",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- },
- "SeqTp": "SEQTP"
- },
- "IntrBkSttlmAmt": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "InstdAmt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "XchgRate": 123.45,
- "ChrgBr": "SHAR",
- "ChrgsInf": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- },
- "Dbtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "CODE"
- },
- "InstrForNxtAgt": {
- "Cd": "CODE"
- },
- "Purp": {
- "Cd": "CASH"
- },
- "RgltryRptg": {
- "Dbtr": true,
- "Cdtr": true
- },
- "Tax": "Cdtr"
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm",
- "NbOfTxs",
- "SttlmInf",
- "CdtTrfTxInf"
- ],
- "example": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "SttlmInf": {
- "SttlmMtd": "INDA",
- "SttlmAcct": {
- "Id": {
- "IBAN": 123
- }
- },
- "SttlmAcctOwnr": {
- "Nm": "John Doe"
- },
- "SttlmAcctSvcr": {
- "BICFI": 123
- }
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 123,
- "EndToEndId": 123
- },
- "PmtTpInf": {
- "InstrPrty": "NORM"
- },
- "InstdAmt": {
- "Amt": 123,
- "Ccy": "EUR"
- },
- "ChrgBr": "SLEV",
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": 123
- }
- },
- "Cdtr": {
- "Nm": "John Doe"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": 123
- }
- },
- "RmtInf": {
- "Ustrd": "Test"
- }
- }
- }
- },
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction68",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "title": "PaymentTypeInformation28",
- "description": "Provides further details of the type of payment.\n",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "DbtrAcct": {
- "description": "DebtorAccount\nAccount used to process a payment.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAcct": {
- "description": "CreditorAccount\nAccount to which a credit entry is made.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
- },
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "Dbtr",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- }
- },
- "IntrBkSttlmAmt": {
- "Amount": 123.45,
- "Ccy": "EUR"
- },
- "Dbtr": {
- "Nm": "Debtor Name"
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "Creditor Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "INSTRUCTION"
- },
- "Purp": {
- "Cd": "CHAR"
- },
- "VrfctnOfTerms": {
- "Cntt": "CONTENT",
- "CnttTp": "PROPRIETARY"
- }
- }
- }
- },
- "required": [
- "GrpHdr",
- "CdtTrfTxInf"
- ],
- "example": {
- "GrpHdr": {
- "MsgId": 20191113001,
- "CreDtTm": "2019-11-13T10:00:00",
- "NbOfTxs": 1,
- "CtrlSum": 1000,
- "InitgPty": {
- "Nm": "Initiating Party Name",
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123456789,
- "SchmeNm": {
- "Cd": "BBA"
- }
- }
- }
- }
- },
- "FwdgAgt": {
- "FinInstnId": {
- "BICFI": "BBBBBBBB"
- }
- },
- "DbtrAgt": {
- "FinInstnId": {
- "BICFI": "AAAAAAAA"
- }
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "CCCCCCCC"
- }
- }
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 20191113001,
- "EndToEndId": 20191113001
- },
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "CtgyPurp": {
- "Cd": "SUPP"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "/ACC/123456789"
- },
- "IntrBkSttlmAmt": {
- "Amt": 1000,
- "Ccy": "EUR"
- },
- "ChrgBr": "SLEV",
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "CCCCCCCC"
- }
- },
- "Cdtr": {
- "Nm": "Creditor Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- }
- },
- "RmtInf": {
- "Ustrd": "Payment for invoice 12345"
- }
- }
- }
- },
- "GenericAccountIdentification1": {
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- },
- "GenericFinancialIdentification1": {
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- },
- "GenericIdentification3": {
- "title": "GenericIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "Issr": "BIC"
- }
- },
- "GenericIdentification30": {
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- },
- "GenericOrganisationIdentification1": {
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- },
- "GenericOrganisationIdentification3": {
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- },
- "GenericPersonIdentification1": {
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- },
- "GenericPersonIdentification2": {
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- },
- "GetPartiesError_IdentificationVerificationReportV03": {
- "title": "GetPartiesError_IdentificationVerificationReportV03",
- "type": "object",
- "properties": {
- "Assgnmt": {
- "description": "Assignment\nInformation related to the identification assignment.\n",
- "title": "IdentificationAssignment3",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n",
- "title": "ISODateTime",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "Assgnr": {
- "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n",
- "title": "Party40Choice",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nIdentification of a person or an organisation.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "Agt": {
- "description": "Agent\nIdentification of a financial institution.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Pty"
- ]
- },
- {
- "required": [
- "Agt"
- ]
- }
- ],
- "example": {
- "Pty": {
- "Nm": "Name",
- "PstlAdr": {
- "Ctry": "US",
- "AdrLine": [
- "Line1",
- "Line2"
- ]
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- }
- }
- },
- "Agt": {
- "FinInstnId": {
- "BICFI": "BUKBGB22"
- },
- "BrnchId": {
- "Id": 12345,
- "Nm": "Oxford Street Branch",
- "PstlAdr": {
- "Ctry": "GB",
- "AdrLine": [
- "1 Oxford Street",
- "London",
- "UK"
- ]
- }
- }
- }
- }
- },
- "Assgne": {
- "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n",
- "title": "Party40Choice",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nIdentification of a person or an organisation.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "Agt": {
- "description": "Agent\nIdentification of a financial institution.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Pty"
- ]
- },
- {
- "required": [
- "Agt"
- ]
- }
- ],
- "example": {
- "Pty": {
- "Nm": "Name",
- "PstlAdr": {
- "Ctry": "US",
- "AdrLine": [
- "Line1",
- "Line2"
- ]
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- }
- }
- },
- "Agt": {
- "FinInstnId": {
- "BICFI": "BUKBGB22"
- },
- "BrnchId": {
- "Id": 12345,
- "Nm": "Oxford Street Branch",
- "PstlAdr": {
- "Ctry": "GB",
- "AdrLine": [
- "1 Oxford Street",
- "London",
- "UK"
- ]
- }
- }
- }
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm",
- "Assgnr",
- "Assgne"
- ],
- "example": {
- "MsgId": 123,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "Assgnr": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "Assgne": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- }
- }
- },
- "Rpt": {
- "description": "Report\nInformation concerning the verification of the identification data for which verification was requested.\n",
- "title": "VerificationReport4",
- "type": "object",
- "properties": {
- "OrgnlId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Vrfctn": {
- "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n",
- "title": "IdentificationVerificationIndicator",
- "type": "boolean",
- "example": true
- },
- "Rsn": {
- "description": "Reason.\nSpecifies the reason why the verified identification information is incorrect.\n",
- "title": "VerificationReason1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n",
- "title": "ExternalVerificationReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "AGNT"
- }
- },
- "OrgnlPtyAndAcctId": {
- "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n",
- "title": "IdentificationInformation4",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "Acct": {
- "description": "Account\nUnambiguous identification of the account of a party.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "Agt": {
- "description": "Agent\nFinancial institution servicing an account for a party.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- }
- },
- "example": {
- "Pty": {
- "Id": {
- "OrgId": {
- "AnyBIC": {
- "BICFI": "BICFI"
- }
- }
- },
- "CtryOfRes": "FI"
- },
- "Acct": {
- "Id": {
- "IBAN": "FI2112345600000785"
- }
- },
- "Agt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- }
- }
- },
- "UpdtdPtyAndAcctId": {
- "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n",
- "title": "IdentificationInformation4",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "Acct": {
- "description": "Account\nUnambiguous identification of the account of a party.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "Agt": {
- "description": "Agent\nFinancial institution servicing an account for a party.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- }
- },
- "example": {
- "Pty": {
- "Id": {
- "OrgId": {
- "AnyBIC": {
- "BICFI": "BICFI"
- }
- }
- },
- "CtryOfRes": "FI"
- },
- "Acct": {
- "Id": {
- "IBAN": "FI2112345600000785"
- }
- },
- "Agt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- }
- }
- }
- },
- "required": [
- "OrgnlId",
- "Vrfctn"
- ],
- "example": {
- "OrgnlId": 1.2345678901234568e+33,
- "Vrfctn": true,
- "OrgnlPtyAndAcctId": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "1234 Elm St",
- "BldgNb": 1234,
- "PstCd": 12345,
- "TwnNm": "Anytown",
- "CtrySubDvsn": "CA",
- "Ctry": "US"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "ABCDUS33",
- "Othr": {
- "Id": 123456789,
- "Issr": "ABA"
- }
- }
- }
- },
- "UpdtdPtyAndAcctId": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "1234 Elm St",
- "BldgNb": 1234,
- "PstCd": 12345,
- "TwnNm": "Anytown",
- "CtrySubDvsn": "CA",
- "Ctry": "US"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "ABCDUS33",
- "Othr": {
- "Id": 123456789,
- "Issr": "ABA"
- }
- }
- }
- }
- }
- },
- "SplmtryData": {
- "description": "SupplementaryData\nAdditional information that cannot be captured in the structured elements and/or any other specific block.\n",
- "title": "SupplementaryData1",
- "type": "object",
- "properties": {
- "PlcAndNm": {
- "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n",
- "title": "Max350Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 350,
- "example": 350
- },
- "Envlp": {
- "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
- "title": "SupplementaryDataEnvelope1",
- "type": "object"
- }
- },
- "required": [
- "Envlp"
- ],
- "example": {
- "PlcAndNm": "Additional information",
- "Envlp": {
- "Cd": "CH03",
- "Prtry": "Additional information"
- }
- }
- }
- },
- "required": [
- "Assgnmt",
- "Rpt"
- ],
- "example": {
- "Assgnmt": {
- "Id": 123,
- "CreDtTm": "2013-03-07T16:30:00",
- "Assgnr": {
- "Id": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- },
- "Assgne": {
- "Id": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "Rpt": {
- "Id": 123,
- "CreDtTm": "2013-03-07T16:30:00",
- "RptgPty": {
- "Id": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- },
- "RptdPty": {
- "Id": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- },
- "RptdDoc": {
- "Nb": 123,
- "RltdDt": "2013-03-07",
- "RltdDtTp": {
- "Cd": 123
- }
- },
- "Rsn": {
- "Cd": 123,
- "Prtry": 123
- }
- },
- "SplmtryData": {
- "PlcAndNm": 123,
- "Envlp": 123,
- "RltdDt": "2013-03-07",
- "RltdDtTp": {
- "Cd": 123
- }
- }
- }
- },
- "GetParties_IdentificationVerificationReportV03": {
- "title": "GetParties_IdentificationVerificationReportV03",
- "type": "object",
- "properties": {
- "Assgnmt": {
- "description": "Assignment\nIdentifies the identification assignment.\n",
- "title": "IdentificationAssignment3",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n",
- "title": "ISODateTime",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "Assgnr": {
- "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n",
- "title": "Party40Choice",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nIdentification of a person or an organisation.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "Agt": {
- "description": "Agent\nIdentification of a financial institution.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
+ "RgltryRptg": {
+ "allOf": [
+ {
+ "title": "RegulatoryReporting3",
+ "description": "Information needed due to regulatory and/or statutory requirements.\n",
"type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "properties": {
+ "DbtCdtRptgInd": {
+ "allOf": [
+ {
+ "title": "RegulatoryReportingType1Code",
+ "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n",
+ "type": "string",
+ "enum": [
+ "CRED",
+ "DEBT",
+ "BOTH"
+ ],
+ "example": "BOTH"
+ },
+ {
+ "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n"
+ }
+ ]
+ },
+ "Authrty": {
+ "allOf": [
+ {
+ "title": "RegulatoryAuthority2",
+ "description": "Information about an entity requiring the regulatory reporting information.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "CHQB"
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Authority\n\nEntity requiring the regulatory reporting information.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "Dtls": {
+ "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
+ "anyOf": [
+ {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
+ "Tp": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -59870,347 +36223,524 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
- ],
+ },
"example": {
- "Cd": "ADDR"
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
}
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "items": {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ "type": "array"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
+ }
+ },
+ "example": {
+ "DbtCdtRptgInd": "CRED",
+ "Authrty": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ "Dtls": {
+ "Cd": "A1",
+ "Inf": "Mandatory regulatory information"
+ }
+ }
+ },
+ {
+ "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Tax": {
+ "allOf": [
+ {
+ "title": "TaxData1",
+ "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n",
+ "type": "object",
+ "properties": {
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "TaxParty1",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the creditor.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT"
+ }
+ },
+ {
+ "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n"
+ }
+ ]
+ },
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "BIC"
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "UltmtDbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Issr": {
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -60218,123 +36748,93 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "ADDR"
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
}
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
+ {
+ "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n"
+ }
+ ]
+ },
+ "AdmstnZone": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -60342,15 +36842,29 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n"
+ }
+ ]
+ },
+ "RefNb": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 140,
+ "example": 12345
},
- "CtrySubDvsn": {
+ {
+ "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n"
+ }
+ ]
+ },
+ "Mtd": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -60358,956 +36872,2482 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Pty"
- ]
- },
- {
- "required": [
- "Agt"
- ]
- }
- ],
- "example": {
- "Pty": {
- "Nm": "Name",
- "PstlAdr": {
- "Ctry": "US",
- "AdrLine": [
- "Line1",
- "Line2"
- ]
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- }
- }
- },
- "Agt": {
- "FinInstnId": {
- "BICFI": "BUKBGB22"
- },
- "BrnchId": {
- "Id": 12345,
- "Nm": "Oxford Street Branch",
- "PstlAdr": {
- "Ctry": "GB",
- "AdrLine": [
- "1 Oxford Street",
- "London",
- "UK"
- ]
- }
- }
- }
- }
- },
- "Assgne": {
- "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n",
- "title": "Party40Choice",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nIdentification of a person or an organisation.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
+ ]
+ },
+ "TtlTaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
- "type": "string",
- "example": "ADDR"
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlTaxAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
"type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "format": "date",
+ "example": "2013-03-07"
},
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
+ {
+ "description": "Date\n\nDate by which tax is due.\n"
+ }
+ ]
+ },
+ "SeqNb": {
+ "allOf": [
+ {
+ "title": "Number",
"type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "pattern": "^[\\d\\-\\.\\,]{1,18}$",
+ "example": 256
},
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
+ {
+ "description": "SequenceNumber\n\nSequential number of the tax report.\n"
+ }
+ ]
+ },
+ "Rcrd": {
+ "description": "Record\n\nDetails of the tax record.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
"type": "object",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
},
- "Prtry": {
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
- "required": [
- "Id"
- ],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
},
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
+ "AddtlInf": "VAT applicable"
}
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "items": {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
},
- {
- "required": [
- "Prtry"
- ]
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
}
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ },
+ "AddtlInf": "VAT applicable"
}
},
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ "type": "array"
}
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
]
}
- ],
+ },
"example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ "Cdtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
},
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Dbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
},
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "UltmtDbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
},
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "AdmstnZone": "CH",
+ "RefNb": 12345,
+ "Mtd": "A",
+ "TtlTaxblBaseAmt": {
+ "Ccy": "CHF",
+ "Amt": 1000
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "TtlTaxAmt": {
+ "Ccy": "CHF",
+ "Amt": 100
},
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
+ "Dt": "2018-01-01",
+ "SeqNb": 1,
+ "Rcrd": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "Tax\nProvides details on the tax.\n"
+ }
+ ]
+ },
+ "VrfctnOfTerms": {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
},
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IlpV4PrepPacket"
+ ]
+ },
+ {
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "SHA-256 signature of the terms\n"
}
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
+ ]
}
},
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
+ "required": [
+ "Sh256Sgntr"
+ ]
}
- },
+ ],
"example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
- }
- }
+ "IlpV4PrepPacket": "1234567890ABCDEF"
+ }
+ }
+ },
+ "required": [
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "ChrgBr",
+ "Dbtr",
+ "DbtrAgt",
+ "CdtrAgt",
+ "Cdtr"
+ ],
+ "example": {
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
+ },
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ },
+ "SeqTp": "SEQTP"
+ },
+ "IntrBkSttlmAmt": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "InstdAmt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "XchgRate": 123.45,
+ "ChrgBr": "SHAR",
+ "ChrgsInf": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
},
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
+ "FinInstnId": {
+ "BICFI": "BICFI"
}
+ },
+ "Tp": {
+ "Cd": "SHAR"
}
},
- "Agt": {
- "description": "Agent\nIdentification of a financial institution.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
+ "Dbtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "CODE"
+ },
+ "InstrForNxtAgt": {
+ "Cd": "CODE"
+ },
+ "Purp": {
+ "Cd": "CASH"
+ },
+ "RgltryRptg": {
+ "Dbtr": true,
+ "Cdtr": true
+ },
+ "Tax": "Cdtr"
+ }
+ },
+ {
+ "description": "Credit Transfer Transaction Information\nSet of elements providing information specific to the individual credit transfer(s).\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "GrpHdr",
+ "CdtTrfTxInf"
+ ],
+ "example": {
+ "GrpHdr": {
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "SttlmInf": {
+ "SttlmMtd": "INDA",
+ "SttlmAcct": {
+ "Id": {
+ "IBAN": 123
+ }
+ },
+ "SttlmAcctOwnr": {
+ "Nm": "John Doe"
+ },
+ "SttlmAcctSvcr": {
+ "BICFI": 123
+ }
+ }
+ },
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": 123,
+ "EndToEndId": 123
+ },
+ "PmtTpInf": {
+ "InstrPrty": "NORM"
+ },
+ "InstdAmt": {
+ "Amt": 123,
+ "Ccy": "EUR"
+ },
+ "ChrgBr": "SLEV",
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": 123
+ }
+ },
+ "Cdtr": {
+ "Nm": "John Doe"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": 123
+ }
+ },
+ "RmtInf": {
+ "Ustrd": "Test"
+ }
+ }
+ }
+ },
+ "Extension": {
+ "title": "Extension",
+ "type": "object",
+ "description": "Data model for the complex type Extension.",
+ "properties": {
+ "key": {
+ "title": "ExtensionKey",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 32,
+ "description": "Extension key."
+ },
+ "value": {
+ "title": "ExtensionValue",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "description": "Extension value."
+ }
+ },
+ "required": [
+ "key",
+ "value"
+ ]
+ },
+ "ExtensionKey": {
+ "title": "ExtensionKey",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 32,
+ "description": "Extension key."
+ },
+ "ExtensionList": {
+ "title": "ExtensionList",
+ "type": "object",
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n",
+ "properties": {
+ "extension": {
+ "type": "array",
+ "items": {
+ "title": "Extension",
+ "type": "object",
+ "description": "Data model for the complex type Extension.",
+ "properties": {
+ "key": {
+ "title": "ExtensionKey",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 32,
+ "description": "Extension key."
+ },
+ "value": {
+ "title": "ExtensionValue",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "description": "Extension value."
+ }
+ },
+ "required": [
+ "key",
+ "value"
+ ]
+ },
+ "minItems": 1,
+ "maxItems": 16,
+ "description": "Number of Extension elements."
+ }
+ },
+ "required": [
+ "extension"
+ ]
+ },
+ "ExtensionValue": {
+ "title": "ExtensionValue",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "description": "Extension value."
+ },
+ "ExternalAccountIdentification1Code": {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalCashAccountType1Code": {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalCategoryPurpose1Code": {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ "ExternalChargeType1Code": {
+ "title": "ExternalChargeType1Code",
+ "description": "Specifies the type of charge applied to the transaction.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalClearingSystemIdentification1Code": {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ "ExternalCreditorAgentInstruction1Code": {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalFinancialInstitutionIdentification1Code": {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalLocalInstrument1Code": {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ "ExternalOrganisationIdentification1Code": {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalPaymentTransactionStatus1Code": {
+ "title": "ExternalPaymentTransactionStatus1Code",
+ "description": "Specifies the external payment transaction status code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalPersonIdentification1Code": {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalProxyAccountType1Code": {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalPurpose1Code": {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalServiceLevel1Code": {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalStatusReason1Code": {
+ "title": "ExternalStatusReason1Code",
+ "description": "Specifies the external status reason code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "ExternalVerificationReason1Code": {
+ "title": "ExternalVerificationReason1Code",
+ "description": "Specifies the external verification reason code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "FinancialIdentificationSchemeName1Choice": {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ "FinancialInstitutionIdentification18": {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
"type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
+ "Cd": {
+ "allOf": [
+ {
"title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
"type": "string",
"minLength": 1,
"maxLength": 5,
"example": 12345
},
- "Prtry": {
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Generic scheme identification for a party.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
+ "Id": {
+ "allOf": [
+ {
"title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
"type": "string",
"pattern": "^[a-zA-Z0-9]{4}$",
"example": 1234
},
- "Issr": {
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -61315,3426 +39355,7553 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
+ },
+ "required": [
+ "Id",
+ "Issr"
],
"example": {
- "Cd": "ADDR"
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
}
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
+ "Cd": {
+ "allOf": [
+ {
"title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
"type": "string",
"minLength": 1,
"maxLength": 4,
"example": 1234
},
- "Prtry": {
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
+ "Prtry"
+ ]
}
- },
+ ],
"example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
+ "Cd": "BIC"
}
},
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ "FinancialInstitutionIdentification23": {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
"type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
"type": "string",
- "example": "ADDR"
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
}
- },
- "oneOf": [
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
}
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
}
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Pty"
]
},
- {
- "required": [
- "Agt"
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
]
}
+ },
+ "required": [
+ "MmbId"
],
"example": {
- "Pty": {
- "Nm": "Name",
- "PstlAdr": {
- "Ctry": "US",
- "AdrLine": [
- "Line1",
- "Line2"
- ]
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- }
- }
+ "ClrSysId": {
+ "Cd": "CHQB"
},
- "Agt": {
- "FinInstnId": {
- "BICFI": "BUKBGB22"
- },
- "BrnchId": {
- "Id": 12345,
- "Nm": "Oxford Street Branch",
- "PstlAdr": {
- "Ctry": "GB",
- "AdrLine": [
- "1 Oxford Street",
- "London",
- "UK"
- ]
- }
- }
- }
+ "MmbId": 123456789
}
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
}
- },
- "required": [
- "MsgId",
- "CreDtTm",
- "Assgnr",
- "Assgne"
- ],
- "example": {
- "MsgId": 123,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "Assgnr": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "Assgne": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
}
- }
+ ]
},
- "Rpt": {
- "description": "Report\nInformation concerning the verification of the identification data for which verification was requested.\n",
- "title": "VerificationReport4",
- "type": "object",
- "properties": {
- "OrgnlId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Vrfctn": {
- "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n",
- "title": "IdentificationVerificationIndicator",
- "type": "boolean",
- "example": true
+ "maxLength": 140,
+ "example": 12345
},
- "Rsn": {
- "description": "Reason.\nSpecifies the reason why the verified identification information is incorrect.\n",
- "title": "VerificationReason1Choice",
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n",
- "title": "ExternalVerificationReason1Code",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Prtry": {
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "AGNT"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
}
},
- "OrgnlPtyAndAcctId": {
- "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n",
- "title": "IdentificationInformation4",
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ "FxRequest_FICreditTransferProposal": {
+ "title": "FxRequest_FICreditTransferProposal",
+ "type": "object",
+ "description": "FxRequest_FICreditTransferProposal\nA group of elements providing information specific to the individual credit transfer(s) included in the message.\n",
+ "properties": {
+ "GrpHdr": {
+ "allOf": [
+ {
+ "title": "GroupHeader113",
+ "description": "Set of characteristics shared by all individual transactions included in the message.\n",
"type": "object",
"properties": {
- "Pty": {
- "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Message Identification\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
+ {
+ "description": "Creation Date and Time\n"
+ }
+ ]
+ },
+ "NbOfTxs": {
+ "allOf": [
+ {
+ "title": "Max15NumericText",
+ "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
+ "type": "string",
+ "pattern": "^[0-9]{1,15}$",
+ "example": 123456789012345
+ },
+ {
+ "description": "Number of Transactions\n"
+ }
+ ]
+ },
+ "TtlIntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Total Interbank Settlement Amount\n"
+ }
+ ]
+ },
+ "SttlmInf": {
+ "allOf": [
+ {
+ "title": "SettlementInstruction15",
+ "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
+ "type": "object",
+ "properties": {
+ "SttlmMtd": {
+ "title": "SettlementMethod1Code",
+ "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n",
+ "type": "string",
+ "enum": [
+ "INDA",
+ "INGA",
+ "COVE",
+ "CLRG"
+ ],
+ "example": "CLRG"
+ },
+ "PmtTpInf": {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
"enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
+ "HIGH",
+ "NORM"
],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
- "example": "ADDR"
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "ADDR"
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
}
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ }
+ },
+ "required": [
+ "SttlmMtd"
+ ],
+ "example": {
+ "SttlmMtd": "INDA",
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CH03"
+ },
+ "CtgyPurp": {
+ "Cd": "SUPP"
+ },
+ "Cdtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "AdrLine": "Address",
+ "Ctry": "CH"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN",
+ "Issr": "BIC"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "CH",
+ "CtctDtls": {
+ "Nm": "Name",
+ "PhneNb": 123,
+ "EmailAdr": null
+ }
+ }
+ }
+ }
+ },
+ {
+ "description": "Settlement Information\n"
+ }
+ ]
+ },
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
+ "type": "object",
+ "properties": {
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
},
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
}
},
"example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
}
},
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
+ {
+ "description": "Payment Type Information\n"
+ }
+ ]
+ },
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction68",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
"type": "object",
"properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
"type": "object",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Prtry": {
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "UETR": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
+ ]
}
},
"required": [
- "Id"
+ "TxId"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
}
+ },
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
+ ]
},
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
},
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
+ },
+ {
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
+ }
+ ]
+ },
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
"required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
+ "ActiveCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
+ }
+ ]
+ },
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
+ }
+ ]
+ },
+ "DbtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
"Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Prxy": {
+ "allOf": [
{
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
- "required": [
- "Id"
- ],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "Issr": "BIC"
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ {
+ "description": "DebtorAccount\nAccount used to process a payment.\n"
}
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "Acct": {
- "description": "Account\nUnambiguous identification of the account of a party.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
},
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
]
}
+ },
+ "required": [
+ "FinInstnId"
],
"example": {
- "Cd": 1111
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "CdtrAgt": {
+ "allOf": [
{
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "Agt": {
- "description": "Agent\nFinancial institution servicing an account for a party.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ ]
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
]
}
+ },
+ "required": [
+ "FinInstnId"
],
"example": {
- "Cd": "CHQB"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ {
+ "description": "CreditorAccount\nAccount to which a credit entry is made.\n"
+ }
+ ]
+ },
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
"type": "object",
"properties": {
"Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
}
},
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "CH03"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "VrfctnOfTerms": {
+ "allOf": [
+ {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
+ "type": "string",
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
+ },
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "IlpV4PrepPacket"
]
},
{
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "SHA-256 signature of the terms\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
+ "Sh256Sgntr"
]
}
],
"example": {
- "Cd": "ADDR"
+ "IlpV4PrepPacket": "1234567890ABCDEF"
}
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
}
},
+ "required": [
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "Dbtr",
+ "Cdtr"
+ ],
"example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
+ },
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ }
+ },
+ "IntrBkSttlmAmt": {
+ "Amount": 123.45,
+ "Ccy": "EUR"
+ },
+ "Dbtr": {
+ "Nm": "Debtor Name"
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "Creditor Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "INSTRUCTION"
+ },
+ "Purp": {
+ "Cd": "CHAR"
+ },
+ "VrfctnOfTerms": {
+ "Cntt": "CONTENT",
+ "CnttTp": "PROPRIETARY"
}
}
+ },
+ {
+ "description": "Credit Transfer Transaction Information\n"
}
+ ]
+ }
+ },
+ "required": [
+ "MsgId",
+ "CreDtTm",
+ "NbOfTxs",
+ "SttlmInf",
+ "CdtTrfTxInf"
+ ],
+ "example": {
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "TtlIntrBkSttlmAmt": {
+ "Ccy": "EUR",
+ "Value": 100
+ },
+ "SttlmInf": {
+ "SttlmMtd": "INDA",
+ "SttlmAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Ccy": "EUR"
},
- "required": [
- "FinInstnId"
- ],
- "example": {
+ "SttlmAcctOwnr": {
+ "Nm": "Name"
+ },
+ "SttlmAcctSvcr": {
+ "Nm": "Name"
+ },
+ "SttlmAgt": {
"FinInstnId": {
- "BICFI": "J5BMVH7D"
+ "BICFI": "BIC"
+ }
+ }
+ },
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "CtgyPurp": "CASH"
+ },
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": 12345,
+ "EndToEndId": 12345
+ },
+ "Amt": {
+ "InstdAmt": {
+ "Ccy": "EUR",
+ "Value": 100
+ }
+ },
+ "Cdtr": {
+ "Nm": "Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ "Ccy": "EUR"
+ },
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BIC"
}
+ },
+ "CdtrAgtAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Ccy": "EUR"
+ },
+ "RmtInf": {
+ "Ustrd": "Test"
}
}
+ }
+ },
+ {
+ "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "GrpHdr"
+ ],
+ "example": {
+ "GrpHdr": {
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "TtlIntrBkSttlmAmt": {
+ "Ccy": "EUR",
+ "Value": 100
+ },
+ "SttlmInf": {
+ "SttlmMtd": "INDA",
+ "SttlmAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Ccy": "EUR"
+ },
+ "SttlmAcctOwnr": {
+ "Nm": "Name"
+ },
+ "SttlmAcctSvcr": {
+ "Nm": "Name"
+ },
+ "SttlmAgt": {
+ "FinInstnId": {
+ "BICFI": "BIC"
+ }
+ }
+ },
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "CtgyPurp": "CASH"
+ },
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": 12345,
+ "EndToEndId": 12345
+ },
+ "Amt": {
+ "InstdAmt": {
+ "Ccy": "EUR",
+ "Value": 100
+ }
+ },
+ "Cdtr": {
+ "Nm": "Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Ccy": "EUR"
+ },
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BIC"
+ }
+ },
+ "Dbtr": {
+ "Nm": "Name"
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "example": {
- "Pty": {
- "Id": {
- "OrgId": {
- "AnyBIC": {
- "BICFI": "BICFI"
- }
- }
- },
- "CtryOfRes": "FI"
- },
- "Acct": {
- "Id": {
- "IBAN": "FI2112345600000785"
- }
+ "Ccy": "EUR"
+ },
+ "DbtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BIC"
+ }
+ },
+ "IntrBkSttlmAmt": {
+ "Ccy": "EUR",
+ "Value": 100
+ },
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ },
+ "RgltryRptg": {
+ "Dbtr": {
+ "Nm": "Name"
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "Agt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
+ "Ccy": "EUR"
+ },
+ "DbtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BIC"
}
+ },
+ "Cdtr": {
+ "Nm": "Name"
}
- },
- "UpdtdPtyAndAcctId": {
- "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n",
- "title": "IdentificationInformation4",
+ }
+ }
+ }
+ }
+ },
+ "FxResponse_FICreditTransferConfirmation": {
+ "title": "FxResponse_FICreditTransferConfirmation",
+ "type": "object",
+ "description": "FxResponse_FICreditTransferConfirmation\nThe FxResponse_FICreditTransferConfirmation message is sent by the FSP to the Payer FSP to confirm the successful processing of the credit transfer.\n",
+ "properties": {
+ "GrpHdr": {
+ "allOf": [
+ {
+ "title": "GroupHeader113",
+ "description": "Set of characteristics shared by all individual transactions included in the message.\n",
"type": "object",
"properties": {
- "Pty": {
- "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
+ {
+ "description": "Message Identification\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Creation Date and Time\n"
+ }
+ ]
+ },
+ "NbOfTxs": {
+ "allOf": [
+ {
+ "title": "Max15NumericText",
+ "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
+ "type": "string",
+ "pattern": "^[0-9]{1,15}$",
+ "example": 123456789012345
+ },
+ {
+ "description": "Number of Transactions\n"
+ }
+ ]
+ },
+ "TtlIntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
"type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
}
- },
- "oneOf": [
+ ]
+ },
+ "Ccy": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
"example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
+ {
+ "description": "Total Interbank Settlement Amount\n"
+ }
+ ]
+ },
+ "SttlmInf": {
+ "allOf": [
+ {
+ "title": "SettlementInstruction15",
+ "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
"type": "object",
"properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
+ "SttlmMtd": {
+ "title": "SettlementMethod1Code",
+ "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n",
+ "type": "string",
+ "enum": [
+ "INDA",
+ "INGA",
+ "COVE",
+ "CLRG"
+ ],
+ "example": "CLRG"
+ },
+ "PmtTpInf": {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
},
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "SEPA"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "CCPT"
+ "Cd": "CASH"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
}
}
}
},
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
+ "required": [
+ "SttlmMtd"
],
"example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "SttlmMtd": "INDA",
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CH03"
+ },
+ "CtgyPurp": {
+ "Cd": "SUPP"
+ },
+ "Cdtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "AdrLine": "Address",
+ "Ctry": "CH"
},
"Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
+ "OrgId": {
+ "AnyBIC": "BIC",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN",
+ "Issr": "BIC"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "CH",
+ "CtctDtls": {
+ "Nm": "Name",
+ "PhneNb": 123,
+ "EmailAdr": null
}
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
}
}
}
},
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
+ {
+ "description": "Settlement Information\n"
}
- }
+ ]
},
- "Acct": {
- "description": "Account\nUnambiguous identification of the account of a party.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": 1111
+ "Cd": "SEPA"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "LclInstrm": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "Agt": {
- "description": "Agent\nFinancial institution servicing an account for a party.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "CHQB"
+ "Cd": "CASH"
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
},
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "LclInstrm": {
+ "Cd": "CORE"
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
+ },
+ {
+ "description": "Payment Type Information\n"
+ }
+ ]
+ },
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction68",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
+ "type": "object",
+ "properties": {
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Issr": {
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
+ },
+ "EndToEndId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -64742,2367 +46909,10252 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "UETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
]
}
+ },
+ "required": [
+ "TxId"
],
"example": {
- "Cd": "ADDR"
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
}
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
+ },
+ {
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
+ }
+ ]
+ },
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
+ }
+ ]
+ },
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
]
}
+ },
+ "required": [
+ "FinInstnId"
],
"example": {
- "Cd": "BIC"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "DbtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "DebtorAccount\nAccount used to process a payment.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- }
- },
- "example": {
- "Pty": {
- "Id": {
- "OrgId": {
- "AnyBIC": {
- "BICFI": "BICFI"
- }
- }
- },
- "CtryOfRes": "FI"
- },
- "Acct": {
- "Id": {
- "IBAN": "FI2112345600000785"
- }
- },
- "Agt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- }
- }
- }
- },
- "required": [
- "OrgnlId",
- "Vrfctn"
- ],
- "example": {
- "OrgnlId": 1.2345678901234568e+33,
- "Vrfctn": true,
- "OrgnlPtyAndAcctId": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "1234 Elm St",
- "BldgNb": 1234,
- "PstCd": 12345,
- "TwnNm": "Anytown",
- "CtrySubDvsn": "CA",
- "Ctry": "US"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "ABCDUS33",
- "Othr": {
- "Id": 123456789,
- "Issr": "ABA"
- }
- }
- }
- },
- "UpdtdPtyAndAcctId": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "1234 Elm St",
- "BldgNb": 1234,
- "PstCd": 12345,
- "TwnNm": "Anytown",
- "CtrySubDvsn": "CA",
- "Ctry": "US"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "ABCDUS33",
- "Othr": {
- "Id": 123456789,
- "Issr": "ABA"
- }
- }
- }
- }
- }
- },
- "SplmtryData": {
- "description": "SupplementaryData\nAdditional information that cannot be captured in the structured elements and/or any other specific block.\n",
- "title": "SupplementaryData1",
- "type": "object",
- "properties": {
- "PlcAndNm": {
- "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n",
- "title": "Max350Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 350,
- "example": 350
- },
- "Envlp": {
- "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
- "title": "SupplementaryDataEnvelope1",
- "type": "object"
- }
- },
- "required": [
- "Envlp"
- ],
- "example": {
- "PlcAndNm": "Additional information",
- "Envlp": {
- "Cd": "CH03",
- "Prtry": "Additional information"
- }
- }
- }
- },
- "required": [
- "Assgnmt",
- "Rpt"
- ],
- "example": {
- "Assgnmt": {
- "MsgId": 123,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "Assgnr": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "Assgne": {
- "OrgId": {
- "Othr": {
- "Id": "DFSPID"
- }
- }
- }
- },
- "Rpt": {
- "OrgnlId": 12345678,
- "Vrfctn": true,
- "UpdtdPtyAndAcctId": {
- "Pty": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 18761231234
- },
- "SchmeNm": {
- "Prtry": "MSISDN"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- }
- }
- }
- },
- "GroupHeader113": {
- "title": "GroupHeader113",
- "description": "Set of characteristics shared by all individual transactions included in the message.\n",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "NbOfTxs": {
- "title": "Max15NumericText",
- "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
- "type": "string",
- "pattern": "^[0-9]{1,15}$",
- "example": 123456789012345
- },
- "TtlIntrBkSttlmAmt": {
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "SttlmInf": {
- "title": "SettlementInstruction15",
- "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
- "type": "object",
- "properties": {
- "SttlmMtd": {
- "description": "SettlementMethod\nMethod used to settle the (batch of) payment instructions.\n",
- "title": "SettlementMethod1Code",
- "type": "string",
- "enum": [
- "INDA",
- "INGA",
- "COVE",
- "CLRG"
- ],
- "example": "CLRG"
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
+ ]
+ },
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
+ }
+ ]
+ },
+ "CdtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
+ }
+ ]
+ },
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
+ }
+ ]
+ },
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
+ },
+ {
+ "description": "CreditorAccount\nAccount to which a credit entry is made.\n"
+ }
+ ]
+ },
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
+ }
+ ]
+ },
+ "VrfctnOfTerms": {
+ "allOf": [
+ {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
+ "type": "string",
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
+ },
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IlpV4PrepPacket"
+ ]
+ },
+ {
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "SHA-256 signature of the terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Sh256Sgntr"
+ ]
+ }
+ ],
+ "example": {
+ "IlpV4PrepPacket": "1234567890ABCDEF"
+ }
+ },
+ {
+ "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- }
- },
- "required": [
- "SttlmMtd"
- ],
- "example": {
- "SttlmMtd": "INDA",
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CH03"
- },
- "CtgyPurp": {
- "Cd": "SUPP"
- },
- "Cdtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "AdrLine": "Address",
- "Ctry": "CH"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN",
- "Issr": "BIC"
- }
- }
- }
- },
- "CtryOfRes": "CH",
- "CtctDtls": {
- "Nm": "Name",
- "PhneNb": 123,
- "EmailAdr": null
- }
- }
- }
- }
- },
- "PmtTpInf": {
- "title": "PaymentTypeInformation28",
- "description": "Provides further details of the type of payment.\n",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "Dbtr",
+ "Cdtr"
+ ],
+ "example": {
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
+ },
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ }
+ },
+ "IntrBkSttlmAmt": {
+ "Amount": 123.45,
+ "Ccy": "EUR"
+ },
+ "Dbtr": {
+ "Nm": "Debtor Name"
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "Creditor Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "INSTRUCTION"
+ },
+ "Purp": {
+ "Cd": "CHAR"
+ },
+ "VrfctnOfTerms": {
+ "Cntt": "CONTENT",
+ "CnttTp": "PROPRIETARY"
+ }
+ }
+ },
+ {
+ "description": "Credit Transfer Transaction Information\n"
+ }
]
}
+ },
+ "required": [
+ "MsgId",
+ "CreDtTm",
+ "NbOfTxs",
+ "SttlmInf",
+ "CdtTrfTxInf"
],
"example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction68",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "TtlIntrBkSttlmAmt": {
+ "Ccy": "EUR",
+ "Value": 100
},
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "SttlmInf": {
+ "SttlmMtd": "INDA",
+ "SttlmAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Ccy": "EUR"
+ },
+ "SttlmAcctOwnr": {
+ "Nm": "Name"
+ },
+ "SttlmAcctSvcr": {
+ "Nm": "Name"
+ },
+ "SttlmAgt": {
+ "FinInstnId": {
+ "BICFI": "BIC"
+ }
+ }
},
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "CtgyPurp": "CASH"
},
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": 12345,
+ "EndToEndId": 12345
+ },
+ "Amt": {
+ "InstdAmt": {
+ "Ccy": "EUR",
+ "Value": 100
+ }
+ },
+ "Cdtr": {
+ "Nm": "Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Ccy": "EUR"
+ },
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BIC"
+ }
+ },
+ "CdtrAgtAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Ccy": "EUR"
+ },
+ "RmtInf": {
+ "Ustrd": "Test"
+ }
}
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
}
},
- "PmtTpInf": {
- "title": "PaymentTypeInformation28",
- "description": "Provides further details of the type of payment.\n",
+ {
+ "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n"
+ }
+ ]
+ },
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction68",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
"type": "object",
"properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
+ "type": "object",
+ "properties": {
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
+ },
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
+ }
+ ]
+ },
+ "UETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "TxId"
+ ],
+ "example": {
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "PmtTpInf": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
+ "type": "object",
+ "properties": {
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
}
- ],
- "example": {
- "Cd": "SEPA"
- }
+ ]
},
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Dbtr": {
+ "allOf": [
{
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
+ ]
},
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "DbtrAcct": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Prxy": {
+ "allOf": [
{
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
- "required": [
- "MmbId"
- ],
"example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "MmbId": 123456789
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
},
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ {
+ "description": "DebtorAccount\nAccount used to process a payment.\n"
+ }
+ ]
+ },
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
"Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
+ "required": [
+ "FinInstnId"
+ ],
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
+ }
+ ]
+ },
+ "CdtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
+ "FinInstnId"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "Issr": "BIC"
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
+ {
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
}
- }
+ ]
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
"Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
+ "required": [
+ "FinInstnId"
+ ],
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
+ },
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
}
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
+ ]
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "DbtrAcct": {
- "description": "DebtorAccount\nAccount used to process a payment.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
"Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Ccy": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
}
- ],
- "example": {
- "Cd": 1111
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
},
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "CreditorAccount\nAccount to which a credit entry is made.\n"
}
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
},
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
"type": "object",
"properties": {
"Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
}
},
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
@@ -67112,4409 +57164,13090 @@
"Cd": "CH03"
}
},
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
+ ]
+ },
+ "VrfctnOfTerms": {
+ "allOf": [
+ {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
+ "type": "string",
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
+ },
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IlpV4PrepPacket"
+ ]
+ },
+ {
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "SHA-256 signature of the terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Sh256Sgntr"
+ ]
+ }
+ ],
+ "example": {
+ "IlpV4PrepPacket": "1234567890ABCDEF"
+ }
},
- "Id": 123
- }
+ {
+ "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n"
+ }
+ ]
}
},
+ "required": [
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "Dbtr",
+ "Cdtr"
+ ],
"example": {
- "Id": {
- "IBAN": "BE71096123456769"
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
},
- "Tp": {
- "Cd": "CACC"
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ }
},
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
+ "IntrBkSttlmAmt": {
+ "Amount": 123.45,
+ "Ccy": "EUR"
+ },
+ "Dbtr": {
+ "Nm": "Debtor Name"
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "Creditor Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "INSTRUCTION"
+ },
+ "Purp": {
+ "Cd": "CHAR"
+ },
+ "VrfctnOfTerms": {
+ "Cntt": "CONTENT",
+ "CnttTp": "PROPRIETARY"
}
}
},
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
+ {
+ "description": "CreditTransferTransactionInformation\nSet of elements providing information specific to the individual credit transfer(s).\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "GrpHdr",
+ "CdtTrfTxInf"
+ ],
+ "example": {
+ "GrpHdr": {
+ "MsgId": "20191122-123456",
+ "CreDtTm": "2019-11-22T12:34:56",
+ "NbOfTxs": 1,
+ "CtrlSum": 100,
+ "InitgPty": {
+ "Nm": "Initiating Party Name"
+ },
+ "MsgRcpt": {
+ "Nm": "Message Recipient Name"
+ }
+ },
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": "20191122-123456",
+ "EndToEndId": "20191122-123456"
+ },
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "CtgyPurp": "SUPP"
+ },
+ "IntrBkSttlmAmt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ },
+ "ChrgBr": "SLEV",
+ "Cdtr": {
+ "Nm": "Creditor Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account"
+ },
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BNBABEBB"
+ }
+ },
+ "CdtrAgtAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account"
+ },
+ "Dbtr": {
+ "Nm": "Debtor Name"
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account"
+ },
+ "DbtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BNBABEBB"
+ }
+ },
+ "DbtrAgtAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account"
+ },
+ "RmtInf": {
+ "Ustrd": "Remittance Information"
+ },
+ "RgltryRptg": {
+ "Dbtr": {
+ "Nm": "Debtor Name"
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account"
+ }
+ }
+ }
+ }
+ },
+ "Fxecute_FinancialInstitutionCreditTransferV12": {
+ "title": "Fxecute_FinancialInstitutionCreditTransferV12",
+ "type": "object",
+ "description": "The Fxecute FinancialInstitutionCreditTransfer message is sent by the initiating party to the executing party to request the execution of a payment. It is used to request movement of funds from the debtor account to the creditor account. The message can carry multiple credit transfer instructions. \n",
+ "properties": {
+ "GrpHdr": {
+ "allOf": [
+ {
+ "title": "GroupHeader129",
+ "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n",
"type": "object",
"properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
+ {
+ "description": "Message Identification\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Creation Date and Time\n"
+ }
+ ]
+ },
+ "PmtInstrXpryDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Payment Instruction Expiry Date and Time\n"
+ }
+ ]
+ },
+ "NbOfTxs": {
+ "allOf": [
+ {
+ "title": "Max15NumericText",
+ "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
+ "type": "string",
+ "pattern": "^[0-9]{1,15}$",
+ "example": 123456789012345
+ },
+ {
+ "description": "Number of Transactions\n"
+ }
+ ]
+ },
+ "SttlmInf": {
+ "allOf": [
+ {
+ "title": "SettlementInstruction15",
+ "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
"type": "object",
"properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "SttlmMtd": {
+ "title": "SettlementMethod1Code",
+ "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n",
+ "type": "string",
+ "enum": [
+ "INDA",
+ "INGA",
+ "COVE",
+ "CLRG"
+ ],
+ "example": "CLRG"
+ },
+ "PmtTpInf": {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
},
- {
- "required": [
- "Prtry"
- ]
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
}
- ],
- "example": {
- "Cd": "CHQB"
}
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
}
},
"required": [
- "MmbId"
+ "SttlmMtd"
],
"example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
+ "SttlmMtd": "INDA",
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CH03"
+ },
+ "CtgyPurp": {
+ "Cd": "SUPP"
+ },
+ "Cdtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "AdrLine": "Address",
+ "Ctry": "CH"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN",
+ "Issr": "BIC"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "CH",
+ "CtctDtls": {
+ "Nm": "Name",
+ "PhneNb": 123,
+ "EmailAdr": null
+ }
+ }
+ }
}
},
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ {
+ "description": "Settlement Information\n"
+ }
+ ]
+ },
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction67",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
"type": "object",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
+ "type": "object",
+ "properties": {
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
+ },
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
+ }
+ ]
+ },
+ "UETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "TxId"
],
- "type": "string",
- "example": "ADDR"
+ "example": {
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
+ }
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
+ }
+ ]
+ },
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
}
+ },
+ {
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "IntrBkSttlmAmt": {
+ "allOf": [
{
+ "title": "ActiveCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "InstdAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "XchgRate": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "BaseOneRate",
+ "type": "string",
+ "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 0.7
},
{
- "required": [
- "Prtry"
- ]
+ "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "ChrgBr": {
+ "title": "ChargeBearerType1Code",
+ "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ "enum": [
+ "DEBT",
+ "CRED",
+ "SHAR",
+ "SLEV"
+ ],
+ "example": "DEBT"
},
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
+ "ChrgsInf": {
+ "allOf": [
+ {
+ "title": "Charges16",
+ "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n",
+ "type": "object",
+ "properties": {
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\nTransaction charges to be paid by the charge bearer.\n"
+ }
+ ]
+ },
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ChargeType3Choice",
+ "description": "ChargeType3Choice\nSpecifies the type of charge.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalChargeType1Code",
+ "description": "Specifies the type of charge applied to the transaction.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCharge type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification3",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "Type\nDefines the type of charges.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt",
+ "Agt"
],
- "type": "string",
- "example": "ADDR"
+ "example": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
+ }
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n"
+ }
+ ]
+ },
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
"Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "Id"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "DbtrAcct": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
"Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Tp": {
+ "Cd": "CACC"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "DbtrAgt": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "FinInstnId"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "CdtrAgt": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "FinInstnId"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "Cdtr": {
+ "allOf": [
{
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Creditor\nParty to which an amount of money is due.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ ]
},
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
"Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAcct": {
- "description": "CreditorAccount\nAccount to which a credit entry is made.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "InstrForNxtAgt": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "InstructionForNextAgent1",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Instruction4Code",
+ "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n",
+ "type": "string",
+ "enum": [
+ "PHOA",
+ "TELA"
+ ],
+ "example": "PHOA"
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n"
}
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
- },
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "Dbtr",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- }
- },
- "IntrBkSttlmAmt": {
- "Amount": 123.45,
- "Ccy": "EUR"
- },
- "Dbtr": {
- "Nm": "Debtor Name"
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "Creditor Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "INSTRUCTION"
- },
- "Purp": {
- "Cd": "CHAR"
- },
- "VrfctnOfTerms": {
- "Cntt": "CONTENT",
- "CnttTp": "PROPRIETARY"
- }
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm",
- "NbOfTxs",
- "SttlmInf",
- "CdtTrfTxInf"
- ],
- "example": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "TtlIntrBkSttlmAmt": {
- "Ccy": "EUR",
- "Value": 100
- },
- "SttlmInf": {
- "SttlmMtd": "INDA",
- "SttlmAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "SttlmAcctOwnr": {
- "Nm": "Name"
- },
- "SttlmAcctSvcr": {
- "Nm": "Name"
- },
- "SttlmAgt": {
- "FinInstnId": {
- "BICFI": "BIC"
- }
- }
- },
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "CtgyPurp": "CASH"
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 12345,
- "EndToEndId": 12345
- },
- "Amt": {
- "InstdAmt": {
- "Ccy": "EUR",
- "Value": 100
- }
- },
- "Cdtr": {
- "Nm": "Name"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": "BIC"
- }
- },
- "CdtrAgtAcct": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Ccy": "EUR"
- },
- "RmtInf": {
- "Ustrd": "Test"
- }
- }
- }
- },
- "GroupHeader120": {
- "title": "GroupHeader120",
- "description": "Set of characteristics shared by all individual transactions included in the message.\n",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "TxInfAndSts": {
- "description": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n",
- "title": "PaymentTransaction163",
- "type": "object",
- "properties": {
- "StsId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlInstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlEndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlTxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlUETR": {
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "TxSts": {
- "title": "ExternalPaymentTransactionStatus1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "StsRsnInf": {
- "title": "StatusReasonInformation14",
- "description": "Unsure on description.\n",
- "type": "object",
- "properties": {
- "Orgtr": {
- "description": "Originator\nParty that issues the status.",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
],
- "type": "string",
- "example": "ADDR"
+ "example": {
+ "Cd": "CH03"
+ }
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
+ }
+ ]
+ },
+ "RgltryRptg": {
+ "allOf": [
+ {
+ "title": "RegulatoryReporting3",
+ "description": "Information needed due to regulatory and/or statutory requirements.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "DbtCdtRptgInd": {
+ "allOf": [
+ {
+ "title": "RegulatoryReportingType1Code",
+ "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n",
+ "type": "string",
+ "enum": [
+ "CRED",
+ "DEBT",
+ "BOTH"
+ ],
+ "example": "BOTH"
+ },
+ {
+ "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Authrty": {
+ "allOf": [
+ {
+ "title": "RegulatoryAuthority2",
+ "description": "Information about an entity requiring the regulatory reporting information.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ }
+ },
+ {
+ "description": "Authority\n\nEntity requiring the regulatory reporting information.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Dtls": {
+ "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
+ "anyOf": [
+ {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ {
+ "items": {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ "type": "array"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "DbtCdtRptgInd": "CRED",
+ "Authrty": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ },
+ "Dtls": {
+ "Cd": "A1",
+ "Inf": "Mandatory regulatory information"
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
+ "Tax": {
+ "allOf": [
+ {
+ "title": "TaxData1",
+ "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "TaxParty1",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the creditor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT"
+ }
+ },
+ {
+ "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n"
+ }
+ ]
+ },
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
+ },
+ {
+ "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n"
+ }
+ ]
+ },
+ "UltmtDbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
+ },
+ {
+ "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n"
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
+ "AdmstnZone": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Prtry": {
+ {
+ "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n"
+ }
+ ]
+ },
+ "RefNb": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n"
+ }
+ ]
+ },
+ "Mtd": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "TtlTaxblBaseAmt": {
+ "allOf": [
{
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
},
{
+ "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlTaxAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
- ]
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate by which tax is due.\n"
+ }
+ ]
+ },
+ "SeqNb": {
+ "allOf": [
+ {
+ "title": "Number",
+ "type": "string",
+ "pattern": "^[\\d\\-\\.\\,]{1,18}$",
+ "example": 256
+ },
+ {
+ "description": "SequenceNumber\n\nSequential number of the tax report.\n"
+ }
+ ]
+ },
+ "Rcrd": {
+ "description": "Record\n\nDetails of the tax record.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ "type": "array"
+ }
+ ]
}
},
- "required": [
- "Id"
- ],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
+ "Cdtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "Dbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "UltmtDbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "AdmstnZone": "CH",
+ "RefNb": 12345,
+ "Mtd": "A",
+ "TtlTaxblBaseAmt": {
+ "Ccy": "CHF",
+ "Amt": 1000
},
- "Issr": "BIC"
+ "TtlTaxAmt": {
+ "Ccy": "CHF",
+ "Amt": 100
+ },
+ "Dt": "2018-01-01",
+ "SeqNb": 1,
+ "Rcrd": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
}
+ },
+ {
+ "description": "Tax\nProvides details on the tax.\n"
}
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
+ ]
},
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
+ "VrfctnOfTerms": {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
"type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
+ "type": "string",
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
+ },
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
}
},
"required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ "IlpV4PrepPacket"
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
+ {
"properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "Sh256Sgntr": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "SHA-256 signature of the terms\n"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ "Sh256Sgntr"
+ ]
}
+ ],
+ "example": {
+ "IlpV4PrepPacket": "1234567890ABCDEF"
}
}
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ },
+ "required": [
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "ChrgBr",
+ "Dbtr",
+ "DbtrAgt",
+ "CdtrAgt",
+ "Cdtr"
+ ],
+ "example": {
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
},
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ },
+ "SeqTp": "SEQTP"
},
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ "IntrBkSttlmAmt": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
},
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ "InstdAmt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
},
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ "XchgRate": 123.45,
+ "ChrgBr": "SHAR",
+ "ChrgsInf": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
},
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
+ "Dbtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
},
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
},
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "DbtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
},
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "CdtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "Cdtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
},
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
}
},
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
+ "InstrForCdtrAgt": {
+ "Cd": "CODE"
+ },
+ "InstrForNxtAgt": {
+ "Cd": "CODE"
+ },
+ "Purp": {
+ "Cd": "CASH"
+ },
+ "RgltryRptg": {
+ "Dbtr": true,
+ "Cdtr": true
+ },
+ "Tax": "Cdtr"
}
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
},
+ {
+ "description": "Credit Transfer Transaction Information\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MsgId",
+ "CreDtTm",
+ "NbOfTxs",
+ "SttlmInf",
+ "CdtTrfTxInf"
+ ],
+ "example": {
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "SttlmInf": {
+ "SttlmMtd": "INDA",
+ "SttlmAcct": {
"Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
+ "IBAN": 123
}
+ },
+ "SttlmAcctOwnr": {
+ "Nm": "John Doe"
+ },
+ "SttlmAcctSvcr": {
+ "BICFI": 123
}
},
- "Rsn": {
- "description": "Reason\nSpecifies the reason for the status report.",
- "title": "StatusReason6Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nReason for the status, as published in an external reason code list.\n",
- "title": "ExternalStatusReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": 123,
+ "EndToEndId": 123
+ },
+ "PmtTpInf": {
+ "InstrPrty": "NORM"
+ },
+ "InstdAmt": {
+ "Amt": 123,
+ "Ccy": "EUR"
+ },
+ "ChrgBr": "SLEV",
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": 123
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
+ "Cdtr": {
+ "Nm": "John Doe"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": 123
}
- ],
- "example": {
- "Cd": "AGNT"
- }
- },
- "AddtlInf": {
- "description": "AdditionalInformation\nAdditional information about the status report.",
- "title": "Max105Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 105,
- "example": 12345
- }
- },
- "example": {
- "Orgtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "SubDepartment",
- "StrtNm": "StreetName",
- "BldgNb": "BuildingNumber",
- "PstCd": "PostCode",
- "TwnNm": "TownName",
- "CtrySubDvsn": "CountrySubDivision",
- "Ctry": "Country"
+ },
+ "RmtInf": {
+ "Ustrd": "Test"
}
- },
- "Rsn": {
- "Cd": "AGNT"
- },
- "AddtlInf": "AdditionalInformation"
- }
- },
- "AccptncDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "AcctSvcrRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "ExctnConf": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- },
- "SplmtryData": {
- "title": "SupplementaryData1",
- "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n",
- "type": "object",
- "properties": {
- "PlcAndNm": {
- "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n",
- "title": "Max350Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 350,
- "example": 350
- },
- "Envlp": {
- "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
- "title": "SupplementaryDataEnvelope1",
- "type": "object"
- }
- },
- "required": [
- "Envlp"
- ],
- "example": {
- "PlcAndNm": "Additional information",
- "Envlp": {
- "Cd": "CH03",
- "Prtry": "Additional information"
}
}
- }
- },
- "example": {
- "StsId": 12345,
- "OrgnlInstrId": 12345,
- "OrgnlEndToEndId": 12345,
- "OrgnlTxId": 12345,
- "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
- "TxSts": "RJCT",
- "StsRsnInf": {
- "Rsn": "RSN",
- "AddtlInf": "ADDITIONAL"
},
- "AccptncDtTm": "2020-01-01T00:00:00Z",
- "AcctSvcrRef": "ACCTSVCRREF",
- "ClrSysRef": "CLRSYSREF",
- "ExctnConf": "1234567890ABCDEF",
- "SplmtryData": {
- "PlcAndNm": "PLACE",
- "Envlp": "ENVELOPE"
+ {
+ "description": "GroupHeader.\nSet of characteristics shared by all individual transactions included in the message.\n"
}
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm"
- ],
- "example": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "TxInfAndSts": {
- "StsId": 12345,
- "OrgnlInstrId": 12345,
- "OrgnlEndToEndId": 12345,
- "OrgnlTxId": 12345,
- "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
- "TxSts": "RJCT",
- "StsRsnInf": {
- "Rsn": "RSN",
- "AddtlInf": "ADDITIONAL"
- },
- "AccptncDtTm": "2020-01-01T00:00:00Z",
- "AcctSvcrRef": "ACCTSVCRREF",
- "ClrSysRef": "CLRSYSREF",
- "ExctnConf": "1234567890ABCDEF",
- "SplmtryData": {
- "PlcAndNm": "PLACE",
- "Envlp": "ENVELOPE"
- }
- }
- }
- },
- "GroupHeader129": {
- "title": "GroupHeader129",
- "description": "Set of characteristics shared by all individual transactions included in the message.\n",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "PmtInstrXpryDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "NbOfTxs": {
- "title": "Max15NumericText",
- "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
- "type": "string",
- "pattern": "^[0-9]{1,15}$",
- "example": 123456789012345
+ ]
},
- "SttlmInf": {
- "title": "SettlementInstruction15",
- "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
- "type": "object",
- "properties": {
- "SttlmMtd": {
- "description": "SettlementMethod\nMethod used to settle the (batch of) payment instructions.\n",
- "title": "SettlementMethod1Code",
- "type": "string",
- "enum": [
- "INDA",
- "INGA",
- "COVE",
- "CLRG"
- ],
- "example": "CLRG"
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n",
- "title": "PaymentTypeInformation28",
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction68",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
"type": "object",
"properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
+ "type": "object",
+ "properties": {
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
+ },
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
+ }
+ ]
+ },
+ "UETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "TxId"
+ ],
+ "example": {
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "PmtTpInf": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
+ "type": "object",
+ "properties": {
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
}
- ],
- "example": {
- "Cd": "SEPA"
- }
+ ]
},
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "IntrBkSttlmAmt": {
+ "allOf": [
{
+ "title": "ActiveCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
+ ]
},
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "Dbtr": {
+ "allOf": [
{
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- }
- },
- "required": [
- "SttlmMtd"
- ],
- "example": {
- "SttlmMtd": "INDA",
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CH03"
- },
- "CtgyPurp": {
- "Cd": "SUPP"
- },
- "Cdtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "AdrLine": "Address",
- "Ctry": "CH"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN",
- "Issr": "BIC"
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
- }
- }
- },
- "CtryOfRes": "CH",
- "CtctDtls": {
- "Nm": "Name",
- "PhneNb": 123,
- "EmailAdr": null
- }
- }
- }
- }
- },
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction67",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n\n Set of elements used to further specify the type of transaction.\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
+ ]
},
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "DbtrAcct": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "DebtorAccount\nAccount used to process a payment.\n"
}
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n",
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "InstdAmt": {
- "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "XchgRate": {
- "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n",
- "title": "BaseOneRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 0.7
- },
- "ChrgBr": {
- "description": "ChargeBearer\nSpecifies which party/parties will bear the charges associated with the processing of the payment transaction.\n",
- "title": "ChargeBearerType1Code",
- "type": "string",
- "enum": [
- "DEBT",
- "CRED",
- "SHAR",
- "SLEV"
- ],
- "example": "DEBT"
- },
- "ChrgsInf": {
- "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction\n",
- "title": "Charges16",
- "type": "object",
- "properties": {
- "Amt": {
- "description": "Amount\n\n Transaction charges to be paid by the charge bearer.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
},
- "Agt": {
- "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
+ "CdtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
]
}
- ],
+ },
+ "required": [],
"example": {
- "Cd": "CHQB"
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
+ "Id": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -71522,1595 +70255,1792 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "BIC"
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
+ ]
}
},
+ "required": [
+ "FinInstnId"
+ ],
"example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "Othr": {
+ "BrnchId": {
"Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
}
}
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
+ {
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
+ }
+ ]
+ },
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 140,
+ "example": 12345
},
- "SchmeNm": {
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
- ],
+ },
"example": {
- "Cd": "ADDR"
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Tp": {
- "description": "Type\n\n Defines the type of charges.\n",
- "title": "ChargeType3Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCharge type, in a coded form.\n",
- "title": "ExternalChargeType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n",
- "title": "GenericIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
+ "FinInstnId"
],
"example": {
- "Id": 123,
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "required": [
- "Amt",
- "Agt"
- ],
- "example": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- }
- },
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
}
}
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
+ }
+ ]
+ },
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
}
- },
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "CACC"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 256,
- "example": 256
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "CCPT"
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Tp": {
+ "Cd": "CACC"
},
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
}
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
}
},
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ {
+ "description": "CreditorAccount\nAccount to which a credit entry is made.\n"
}
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "DbtrAcct": {
- "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
+ ]
+ },
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
"type": "string",
"minLength": 1,
"maxLength": 4,
"example": 1234
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
{
- "required": [
- "Prtry"
- ]
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
}
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
- "required": [
- "Id"
- ],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
}
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
},
{
- "required": [
- "Othr"
- ]
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
}
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
+ ]
},
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "Purp": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
@@ -73120,326 +72050,266 @@
"Cd": "CH03"
}
},
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
+ ]
},
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
+ "VrfctnOfTerms": {
+ "allOf": [
+ {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
"type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
+ "type": "string",
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
+ },
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
]
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ },
+ "required": [
+ "IlpV4PrepPacket"
+ ]
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
+ {
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "SHA-256 signature of the terms\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ },
+ "required": [
+ "Sh256Sgntr"
+ ]
+ }
+ ],
+ "example": {
+ "IlpV4PrepPacket": "1234567890ABCDEF"
+ }
+ },
+ {
+ "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "Dbtr",
+ "Cdtr"
+ ],
+ "example": {
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
+ },
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ }
+ },
+ "IntrBkSttlmAmt": {
+ "Amount": 123.45,
+ "Ccy": "EUR"
+ },
+ "Dbtr": {
+ "Nm": "Debtor Name"
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "Creditor Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "INSTRUCTION"
+ },
+ "Purp": {
+ "Cd": "CHAR"
+ },
+ "VrfctnOfTerms": {
+ "Cntt": "CONTENT",
+ "CnttTp": "PROPRIETARY"
+ }
+ }
+ },
+ {
+ "description": "CreditTransferTransactionInformation.\nSet of elements providing information specific to the individual credit transfer(s).\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "GrpHdr",
+ "CdtTrfTxInf"
+ ],
+ "example": {
+ "GrpHdr": {
+ "MsgId": 20191113001,
+ "CreDtTm": "2019-11-13T10:00:00",
+ "NbOfTxs": 1,
+ "CtrlSum": 1000,
+ "InitgPty": {
+ "Nm": "Initiating Party Name",
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123456789,
+ "SchmeNm": {
+ "Cd": "BBA"
+ }
+ }
+ }
+ }
+ },
+ "FwdgAgt": {
+ "FinInstnId": {
+ "BICFI": "BBBBBBBB"
+ }
+ },
+ "DbtrAgt": {
+ "FinInstnId": {
+ "BICFI": "AAAAAAAA"
+ }
+ },
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "CCCCCCCC"
+ }
+ }
+ },
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": 20191113001,
+ "EndToEndId": 20191113001
+ },
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "CtgyPurp": {
+ "Cd": "SUPP"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "/ACC/123456789"
+ },
+ "IntrBkSttlmAmt": {
+ "Amt": 1000,
+ "Ccy": "EUR"
+ },
+ "ChrgBr": "SLEV",
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "CCCCCCCC"
+ }
+ },
+ "Cdtr": {
+ "Nm": "Creditor Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ "RmtInf": {
+ "Ustrd": "Payment for invoice 12345"
+ }
+ }
+ }
+ },
+ "GenericAccountIdentification1": {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 4,
+ "example": 1234
},
- "CtrySubDvsn": {
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -73447,152 +72317,416 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ "GenericFinancialIdentification1": {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
+ "maxLength": 4,
+ "example": 1234
},
- "Issr": {
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
},
- "Issr": "BIC"
- }
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
}
},
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ "GenericIdentification3": {
+ "title": "GenericIdentification3",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "Issr": "BIC"
+ }
+ },
+ "GenericIdentification30": {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ "GenericOrganisationIdentification1": {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ "GenericOrganisationIdentification3": {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
}
- }
+ ]
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -73600,213 +72734,114 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ "GenericPersonIdentification1": {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 4,
+ "example": 1234
},
- "CtrySubDvsn": {
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -73814,527 +72849,4286 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
}
},
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "FinInstnId"
],
"example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
+ "Cd": "CCPT"
}
},
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ "GenericPersonIdentification2": {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "MmbId": {
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ "GetPartiesError_IdentificationVerificationReportV03": {
+ "title": "GetPartiesError_IdentificationVerificationReportV03",
+ "type": "object",
+ "properties": {
+ "Assgnmt": {
+ "allOf": [
+ {
+ "title": "IdentificationAssignment3",
+ "type": "object",
+ "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n",
+ "properties": {
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
+ {
+ "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ {
+ "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n"
+ }
+ ]
+ },
+ "Assgnr": {
+ "allOf": [
+ {
+ "title": "Party40Choice",
+ "description": "Identification of a person, an organisation or a financial institution.\n",
"type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Party\nIdentification of a person or an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Pty"
+ ]
+ },
+ {
+ "properties": {
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Agent\nIdentification of a financial institution.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
+ "required": [
+ "Agt"
+ ]
+ }
+ ],
+ "example": {
+ "Pty": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "Ctry": "US",
+ "AdrLine": [
+ "Line1",
+ "Line2"
+ ]
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
}
- ],
- "example": {
- "Cd": "ADDR"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BUKBGB22"
+ },
+ "BrnchId": {
+ "Id": 12345,
+ "Nm": "Oxford Street Branch",
+ "PstlAdr": {
+ "Ctry": "GB",
+ "AdrLine": [
+ "1 Oxford Street",
+ "London",
+ "UK"
+ ]
+ }
+ }
+ }
+ }
+ },
+ {
+ "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n"
+ }
+ ]
+ },
+ "Assgne": {
+ "allOf": [
+ {
+ "title": "Party40Choice",
+ "description": "Identification of a person, an organisation or a financial institution.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Party\nIdentification of a person or an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Pty"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "properties": {
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Agent\nIdentification of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Agt"
+ ]
}
- },
+ ],
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Pty": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "Ctry": "US",
+ "AdrLine": [
+ "Line1",
+ "Line2"
+ ]
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
}
+ }
+ },
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BUKBGB22"
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
+ "BrnchId": {
+ "Id": 12345,
+ "Nm": "Oxford Street Branch",
+ "PstlAdr": {
+ "Ctry": "GB",
+ "AdrLine": [
+ "1 Oxford Street",
+ "London",
+ "UK"
]
}
- ],
- "example": {
- "Cd": "BIC"
}
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
}
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
},
+ {
+ "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MsgId",
+ "CreDtTm",
+ "Assgnr",
+ "Assgne"
+ ],
+ "example": {
+ "MsgId": 123,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "Assgnr": {
+ "OrgId": {
"Othr": {
"Id": 123,
"SchmeNm": {
- "Cd": "CHQB"
+ "Cd": "BIC"
},
- "Issr": 123
+ "Issr": "BIC"
}
}
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
+ "Assgne": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ }
+ }
+ },
+ {
+ "description": "Assignment\nInformation related to the identification assignment.\n"
+ }
+ ]
+ },
+ "Rpt": {
+ "allOf": [
+ {
+ "title": "VerificationReport4",
+ "type": "object",
+ "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.",
+ "properties": {
+ "OrgnlId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -74342,1733 +77136,9136 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ {
+ "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n"
+ }
+ ]
+ },
+ "Vrfctn": {
+ "allOf": [
+ {
+ "title": "IdentificationVerificationIndicator",
+ "type": "boolean",
+ "example": true,
+ "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n"
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ {
+ "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n"
+ }
+ ]
+ },
+ "Rsn": {
+ "allOf": [
+ {
+ "title": "VerificationReason1Choice",
"type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n",
+ "oneOf": [
+ {
"properties": {
"Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
+ "allOf": [
+ {
+ "title": "ExternalVerificationReason1Code",
+ "description": "Specifies the external verification reason code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "AGNT"
+ }
+ },
+ {
+ "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n"
+ }
+ ]
+ },
+ "OrgnlPtyAndAcctId": {
+ "allOf": [
+ {
+ "title": "IdentificationInformation4",
+ "type": "object",
+ "description": "Information that locates and identifies a specific party or account.\n",
+ "properties": {
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
],
- "type": "string",
- "example": "ADDR"
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n"
+ }
+ ]
+ },
+ "Acct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
"Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Account\nUnambiguous identification of the account of a party.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Agent\nFinancial institution servicing an account for a party.\n"
+ }
+ ]
}
},
+ "required": [
+ "Pty"
+ ],
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Pty": {
+ "Id": {
+ "OrgId": {
+ "AnyBIC": {
+ "BICFI": "BICFI"
+ }
}
},
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "CtryOfRes": "FI"
+ },
+ "Acct": {
+ "Id": {
+ "IBAN": "FI2112345600000785"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
- {
- "required": [
- "Prtry"
- ]
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
}
- ],
- "example": {
- "Cd": "ADDR"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
+ "UpdtdPtyAndAcctId": {
+ "allOf": [
+ {
+ "title": "IdentificationInformation4",
"type": "object",
+ "description": "Information that locates and identifies a specific party or account.\n",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ {
+ "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n"
+ }
+ ]
+ },
+ "Acct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "BIC"
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "Account\nUnambiguous identification of the account of a party.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
]
}
+ },
+ "required": [
+ "FinInstnId"
],
"example": {
- "Cd": "CCPT"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Agent\nFinancial institution servicing an account for a party.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
+ "required": [
+ "Pty"
+ ],
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "Pty": {
+ "Id": {
+ "OrgId": {
+ "AnyBIC": {
+ "BICFI": "BICFI"
+ }
+ }
+ },
+ "CtryOfRes": "FI"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
+ "Acct": {
+ "Id": {
+ "IBAN": "FI2112345600000785"
}
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
},
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
}
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
}
},
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
+ {
+ "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n"
}
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
+ ]
}
},
+ "required": [
+ "OrgnlId",
+ "Vrfctn",
+ "UpdtdPtyAndAcctId"
+ ],
"example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
+ "OrgnlId": 1.2345678901234568e+33,
+ "Vrfctn": true,
+ "OrgnlPtyAndAcctId": {
"Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "CdtrAcct": {
- "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "1234 Elm St",
+ "BldgNb": 1234,
+ "PstCd": 12345,
+ "TwnNm": "Anytown",
+ "CtrySubDvsn": "CA",
+ "Ctry": "US"
},
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "ABCDUS33",
+ "Othr": {
+ "Id": 123456789,
+ "Issr": "ABA"
+ }
}
- ],
- "example": {
- "IBAN": "BE71096123456769"
}
},
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
+ "UpdtdPtyAndAcctId": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "1234 Elm St",
+ "BldgNb": 1234,
+ "PstCd": 12345,
+ "TwnNm": "Anytown",
+ "CtrySubDvsn": "CA",
+ "Ctry": "US"
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "ABCDUS33",
+ "Othr": {
+ "Id": 123456789,
+ "Issr": "ABA"
}
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
}
}
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "InstrForNxtAgt": {
- "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForNextAgent1",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
- "title": "Instruction4Code",
- "type": "string",
- "enum": [
- "PHOA",
- "TELA"
- ],
- "example": "PHOA"
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone"
}
},
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
+ {
+ "description": "Report\nInformation concerning the verification of the identification data for which verification was requested.\n"
+ }
+ ]
+ },
+ "SplmtryData": {
+ "allOf": [
+ {
+ "title": "SupplementaryData1",
+ "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "PlcAndNm": {
+ "allOf": [
+ {
+ "title": "Max350Text",
+ "description": "Specifies a character string with a maximum length of 350 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 350,
+ "example": 350
+ },
+ {
+ "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Envlp": {
+ "allOf": [
+ {
+ "title": "SupplementaryDataEnvelope1",
+ "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
+ "type": "object"
+ },
+ {
+ "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n"
+ }
]
}
+ },
+ "required": [
+ "Envlp"
],
"example": {
- "Cd": "CH03"
+ "PlcAndNm": "Additional information",
+ "Envlp": {
+ "Cd": "CH03",
+ "Prtry": "Additional information"
+ }
}
},
- "RgltryRptg": {
- "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n",
- "title": "RegulatoryReporting3",
+ {
+ "description": "SupplementaryData\nAdditional information that cannot be captured in the structured elements and/or any other specific block.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Assgnmt",
+ "Rpt"
+ ],
+ "example": {
+ "Assgnmt": {
+ "Id": 123,
+ "CreDtTm": "2013-03-07T16:30:00",
+ "Assgnr": {
+ "Id": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ "Assgne": {
+ "Id": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ "Rpt": {
+ "Id": 123,
+ "CreDtTm": "2013-03-07T16:30:00",
+ "RptgPty": {
+ "Id": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ "RptdPty": {
+ "Id": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ "RptdDoc": {
+ "Nb": 123,
+ "RltdDt": "2013-03-07",
+ "RltdDtTp": {
+ "Cd": 123
+ }
+ },
+ "Rsn": {
+ "Cd": 123,
+ "Prtry": 123
+ }
+ },
+ "SplmtryData": {
+ "PlcAndNm": 123,
+ "Envlp": 123,
+ "RltdDt": "2013-03-07",
+ "RltdDtTp": {
+ "Cd": 123
+ }
+ }
+ }
+ },
+ "GetParties_IdentificationVerificationReportV03": {
+ "title": "GetParties_IdentificationVerificationReportV03",
+ "type": "object",
+ "properties": {
+ "Assgnmt": {
+ "allOf": [
+ {
+ "title": "IdentificationAssignment3",
"type": "object",
+ "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n",
"properties": {
- "DbtCdtRptgInd": {
- "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "title": "RegulatoryReportingType1Code",
- "type": "string",
- "enum": [
- "CRED",
- "DEBT",
- "BOTH"
- ],
- "example": "BOTH"
- },
- "Authrty": {
- "description": "Authority\n\nEntity requiring the regulatory reporting information.\n",
- "title": "RegulatoryAuthority2",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
+ {
+ "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
"type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n"
}
- },
- "example": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- }
+ ]
},
- "Dtls": {
- "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "anyOf": [
+ "Assgnr": {
+ "allOf": [
{
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "title": "Party40Choice",
+ "description": "Identification of a person, an organisation or a financial institution.\n",
"type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
+ "oneOf": [
+ {
+ "properties": {
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Party\nIdentification of a person or an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Pty"
+ ]
},
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
+ {
"properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Agent\nIdentification of a financial institution.\n"
+ }
+ ]
}
},
"required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
+ "Agt"
]
}
- },
+ ],
"example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ "Pty": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "Ctry": "US",
+ "AdrLine": [
+ "Line1",
+ "Line2"
+ ]
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ }
+ }
},
- "Inf": 12345
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BUKBGB22"
+ },
+ "BrnchId": {
+ "Id": 12345,
+ "Nm": "Oxford Street Branch",
+ "PstlAdr": {
+ "Ctry": "GB",
+ "AdrLine": [
+ "1 Oxford Street",
+ "London",
+ "UK"
+ ]
+ }
+ }
+ }
}
},
{
- "items": {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n"
+ }
+ ]
+ },
+ "Assgne": {
+ "allOf": [
+ {
+ "title": "Party40Choice",
+ "description": "Identification of a person, an organisation or a financial institution.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Party\nIdentification of a person or an organisation.\n"
+ }
+ ]
}
},
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "required": [
+ "Pty"
+ ]
+ },
+ {
+ "properties": {
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
},
- "type": "array"
- }
+ {
+ "description": "Agent\nIdentification of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Agt"
+ ]
+ }
+ ],
+ "example": {
+ "Pty": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "Ctry": "US",
+ "AdrLine": [
+ "Line1",
+ "Line2"
]
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ }
}
},
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BUKBGB22"
},
- "Inf": 12345
+ "BrnchId": {
+ "Id": 12345,
+ "Nm": "Oxford Street Branch",
+ "PstlAdr": {
+ "Ctry": "GB",
+ "AdrLine": [
+ "1 Oxford Street",
+ "London",
+ "UK"
+ ]
+ }
+ }
}
- },
- "type": "array"
+ }
+ },
+ {
+ "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n"
}
]
}
},
+ "required": [
+ "MsgId",
+ "CreDtTm",
+ "Assgnr",
+ "Assgne"
+ ],
"example": {
- "DbtCdtRptgInd": "CRED",
- "Authrty": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- },
- "Dtls": {
- "Cd": "A1",
- "Inf": "Mandatory regulatory information"
- }
- }
- },
- "Tax": {
- "description": "Tax\nProvides details on the tax.\n",
- "title": "TaxData1",
- "type": "object",
- "properties": {
- "Cdtr": {
- "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n",
- "title": "TaxParty1",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "MsgId": 123,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "Assgnr": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
}
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT"
}
},
- "Dbtr": {
- "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
+ "Assgne": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
},
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
+ "Issr": "BIC"
}
}
- },
- "UltmtDbtr": {
- "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
+ }
+ }
+ },
+ {
+ "description": "Assignment\nIdentifies the identification assignment.\n"
+ }
+ ]
+ },
+ "Rpt": {
+ "allOf": [
+ {
+ "title": "VerificationReport4",
+ "type": "object",
+ "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.",
+ "properties": {
+ "OrgnlId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -76076,5526 +86273,10957 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "AdmstnZone": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RefNb": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Mtd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TtlTaxblBaseAmt": {
- "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
},
- "TtlTaxAmt": {
- "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "Vrfctn": {
+ "allOf": [
+ {
+ "title": "IdentificationVerificationIndicator",
+ "type": "boolean",
+ "example": true,
+ "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n"
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dt": {
- "description": "Date\n\nDate by which tax is due.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "SeqNb": {
- "description": "SequenceNumber\n\nSequential number of the tax report\n",
- "title": "Number",
- "type": "string",
- "pattern": "^[\\d\\-\\.\\,]{1,18}$",
- "example": 256
+ ]
},
- "Rcrd": {
- "description": "Record\n\nDetails of the tax record.\n",
- "anyOf": [
+ "Rsn": {
+ "allOf": [
{
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
+ "title": "VerificationReason1Choice",
"type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
+ "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n",
+ "oneOf": [
+ {
"properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalVerificationReason1Code",
+ "description": "Specifies the external verification reason code.",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ {
+ "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n"
}
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
+ ]
}
},
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
+ "required": [
+ "Cd"
+ ]
},
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
+ {
"properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "AGNT"
+ }
+ },
+ {
+ "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n"
+ }
+ ]
+ },
+ "OrgnlPtyAndAcctId": {
+ "allOf": [
+ {
+ "title": "IdentificationInformation4",
+ "type": "object",
+ "description": "Information that locates and identifies a specific party or account.\n",
+ "properties": {
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
+ "AdrTp": {
+ "title": "AddressType3Choice",
"type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "FrDt",
- "ToDt"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "Cd": "ADDR"
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
"example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
"type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
],
"example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
}
+ },
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
}
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
}
- }
+ ]
},
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
}
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ {
+ "description": "Other\nContact details in another form.\n"
}
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
+ ]
},
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
}
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
}
},
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
}
- },
- "type": "array"
+ ]
}
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
},
- "Inf": 12345
- }
- }
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
- },
- {
- "items": {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
}
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
}
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
}
},
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ {
+ "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n"
}
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ ]
+ },
+ "Acct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
+ "required": [
+ "IBAN"
+ ]
},
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
}
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
+ "required": [
+ "Cd"
+ ]
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
+ ],
+ "example": {
+ "Cd": "CACC"
}
},
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
}
- },
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
"type": "object",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
"type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "FrDt",
- "ToDt"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "Cd": "EMAIL"
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ {
+ "description": "Type\nType of the proxy identification.\n"
}
- }
+ ]
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
+ "Id"
],
"example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ "Tp": {
+ "Cd": "IBAN"
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ "Id": 123
}
},
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
},
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "Inf": 12345
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
+ },
+ {
+ "description": "Account\nUnambiguous identification of the account of a party.\n"
}
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Cdtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "Dbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "UltmtDbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "AdmstnZone": "CH",
- "RefNb": 12345,
- "Mtd": "A",
- "TtlTaxblBaseAmt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "TtlTaxAmt": {
- "Ccy": "CHF",
- "Amt": 100
- },
- "Dt": "2018-01-01",
- "SeqNb": 1,
- "Rcrd": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
- },
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "ChrgBr",
- "Dbtr",
- "DbtrAgt",
- "CdtrAgt",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- },
- "SeqTp": "SEQTP"
- },
- "IntrBkSttlmAmt": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "InstdAmt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "XchgRate": 123.45,
- "ChrgBr": "SHAR",
- "ChrgsInf": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- },
- "Dbtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "CODE"
- },
- "InstrForNxtAgt": {
- "Cd": "CODE"
- },
- "Purp": {
- "Cd": "CASH"
- },
- "RgltryRptg": {
- "Dbtr": true,
- "Cdtr": true
- },
- "Tax": "Cdtr"
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm",
- "NbOfTxs",
- "SttlmInf",
- "CdtTrfTxInf"
- ],
- "example": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "SttlmInf": {
- "SttlmMtd": "INDA",
- "SttlmAcct": {
- "Id": {
- "IBAN": 123
- }
- },
- "SttlmAcctOwnr": {
- "Nm": "John Doe"
- },
- "SttlmAcctSvcr": {
- "BICFI": 123
- }
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 123,
- "EndToEndId": 123
- },
- "PmtTpInf": {
- "InstrPrty": "NORM"
- },
- "InstdAmt": {
- "Amt": 123,
- "Ccy": "EUR"
- },
- "ChrgBr": "SLEV",
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": 123
- }
- },
- "Cdtr": {
- "Nm": "John Doe"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": 123
- }
- },
- "RmtInf": {
- "Ustrd": "Test"
- }
- }
- }
- },
- "IBAN2007Identifier": {
- "title": "IBAN2007Identifier",
- "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "ISODate": {
- "title": "ISODate",
- "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ISODateTime": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "ISOYear": {
- "title": "ISOYear",
- "description": "Year represented by YYYY (ISO 8601).\n",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- },
- "IdentificationAssignment3": {
- "title": "IdentificationAssignment3",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n",
- "title": "ISODateTime",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "Assgnr": {
- "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n",
- "title": "Party40Choice",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nIdentification of a person or an organisation.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Agent\nFinancial institution servicing an account for a party.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
+ },
+ "required": [
+ "Pty"
],
"example": {
- "Cd": "ADDR"
+ "Pty": {
+ "Id": {
+ "OrgId": {
+ "AnyBIC": {
+ "BICFI": "BICFI"
+ }
+ }
+ },
+ "CtryOfRes": "FI"
+ },
+ "Acct": {
+ "Id": {
+ "IBAN": "FI2112345600000785"
+ }
+ },
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ }
}
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
+ "UpdtdPtyAndAcctId": {
+ "allOf": [
+ {
+ "title": "IdentificationInformation4",
"type": "object",
+ "description": "Information that locates and identifies a specific party or account.\n",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "BIC"
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "Acct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
+ },
+ {
+ "description": "Account\nUnambiguous identification of the account of a party.\n"
+ }
+ ]
+ },
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
]
}
+ },
+ "required": [
+ "FinInstnId"
],
"example": {
- "Cd": "CCPT"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Agent\nFinancial institution servicing an account for a party.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
+ "required": [
+ "Pty"
+ ],
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "Pty": {
+ "Id": {
+ "OrgId": {
+ "AnyBIC": {
+ "BICFI": "BICFI"
+ }
+ }
+ },
+ "CtryOfRes": "FI"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
+ "Acct": {
+ "Id": {
+ "IBAN": "FI2112345600000785"
+ }
+ },
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
}
}
}
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
},
{
- "required": [
- "PrvtId"
- ]
+ "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n"
}
- ],
- "example": {
+ ]
+ }
+ },
+ "required": [
+ "OrgnlId",
+ "Vrfctn",
+ "UpdtdPtyAndAcctId"
+ ],
+ "example": {
+ "OrgnlId": 1.2345678901234568e+33,
+ "Vrfctn": true,
+ "OrgnlPtyAndAcctId": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "1234 Elm St",
+ "BldgNb": 1234,
+ "PstCd": 12345,
+ "TwnNm": "Anytown",
+ "CtrySubDvsn": "CA",
+ "Ctry": "US"
+ },
+ "Id": {
"OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "AnyBIC": "ABCDUS33",
+ "Othr": {
+ "Id": 123456789,
+ "Issr": "ABA"
}
}
}
},
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
+ "UpdtdPtyAndAcctId": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "1234 Elm St",
+ "BldgNb": 1234,
+ "PstCd": 12345,
+ "TwnNm": "Anytown",
+ "CtrySubDvsn": "CA",
+ "Ctry": "US"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "ABCDUS33",
+ "Othr": {
+ "Id": 123456789,
+ "Issr": "ABA"
+ }
+ }
+ }
+ }
+ }
+ },
+ {
+ "description": "Report\nInformation concerning the verification of the identification data for which verification was requested.\n"
+ }
+ ]
+ },
+ "SplmtryData": {
+ "allOf": [
+ {
+ "title": "SupplementaryData1",
+ "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n",
+ "type": "object",
+ "properties": {
+ "PlcAndNm": {
+ "allOf": [
+ {
+ "title": "Max350Text",
+ "description": "Specifies a character string with a maximum length of 350 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ "maxLength": 350,
+ "example": 350
},
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ {
+ "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n"
+ }
+ ]
+ },
+ "Envlp": {
+ "allOf": [
+ {
+ "title": "SupplementaryDataEnvelope1",
+ "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
+ "type": "object"
},
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
+ {
+ "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Envlp"
+ ],
+ "example": {
+ "PlcAndNm": "Additional information",
+ "Envlp": {
+ "Cd": "CH03",
+ "Prtry": "Additional information"
+ }
+ }
+ },
+ {
+ "description": "SupplementaryData\nAdditional information that cannot be captured in the structured elements and/or any other specific block.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Assgnmt",
+ "Rpt"
+ ],
+ "example": {
+ "Assgnmt": {
+ "MsgId": 123,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "Assgnr": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ "Assgne": {
+ "OrgId": {
+ "Othr": {
+ "Id": "DFSPID"
+ }
+ }
+ }
+ },
+ "Rpt": {
+ "OrgnlId": 12345678,
+ "Vrfctn": true,
+ "UpdtdPtyAndAcctId": {
+ "Pty": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 18761231234
+ },
+ "SchmeNm": {
+ "Prtry": "MSISDN"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ }
+ }
+ }
+ },
+ "GroupHeader113": {
+ "title": "GroupHeader113",
+ "description": "Set of characteristics shared by all individual transactions included in the message.\n",
+ "type": "object",
+ "properties": {
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Message Identification\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Creation Date and Time\n"
+ }
+ ]
+ },
+ "NbOfTxs": {
+ "allOf": [
+ {
+ "title": "Max15NumericText",
+ "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
+ "type": "string",
+ "pattern": "^[0-9]{1,15}$",
+ "example": 123456789012345
+ },
+ {
+ "description": "Number of Transactions\n"
+ }
+ ]
+ },
+ "TtlIntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
"type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
},
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Total Interbank Settlement Amount\n"
+ }
+ ]
+ },
+ "SttlmInf": {
+ "allOf": [
+ {
+ "title": "SettlementInstruction15",
+ "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
+ "type": "object",
+ "properties": {
+ "SttlmMtd": {
+ "title": "SettlementMethod1Code",
+ "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n",
+ "type": "string",
+ "enum": [
+ "INDA",
+ "INGA",
+ "COVE",
+ "CLRG"
+ ],
+ "example": "CLRG"
+ },
+ "PmtTpInf": {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
+ "type": "object",
+ "properties": {
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
},
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
},
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
}
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
+ ]
},
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
}
},
"example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
}
}
},
+ "required": [
+ "SttlmMtd"
+ ],
"example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
+ "SttlmMtd": "INDA",
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CH03"
+ },
+ "CtgyPurp": {
+ "Cd": "SUPP"
+ },
+ "Cdtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "AdrLine": "Address",
+ "Ctry": "CH"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN",
+ "Issr": "BIC"
+ }
+ }
}
+ },
+ "CtryOfRes": "CH",
+ "CtctDtls": {
+ "Nm": "Name",
+ "PhneNb": 123,
+ "EmailAdr": null
}
}
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
}
}
},
- "Agt": {
- "description": "Agent\nIdentification of a financial institution.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
+ {
+ "description": "Settlement Information\n"
+ }
+ ]
+ },
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
"type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
"Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
]
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "MmbId"
],
"example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
+ "Cd": "SEPA"
}
},
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
"type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
"properties": {
"Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
"type": "string",
"minLength": 1,
"maxLength": 35,
- "example": 1.234567890123457e+34
+ "example": 12345
},
- "SchmeNm": {
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
+ ],
"example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "Cd": "CASH"
}
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
+ },
+ {
+ "description": "Payment Type Information\n"
+ }
+ ]
+ },
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction68",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
+ "type": "object",
+ "properties": {
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
"type": "object",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Prtry": {
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "UETR": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
+ ]
}
},
"required": [
- "Id"
+ "TxId"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
}
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- }
+ ]
},
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
"type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "Id",
- "Issr"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Cd": "SEPA"
}
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
}
},
"example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
}
+ },
+ {
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
}
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Pty"
- ]
- },
- {
- "required": [
- "Agt"
- ]
- }
- ],
- "example": {
- "Pty": {
- "Nm": "Name",
- "PstlAdr": {
- "Ctry": "US",
- "AdrLine": [
- "Line1",
- "Line2"
- ]
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- }
- }
- },
- "Agt": {
- "FinInstnId": {
- "BICFI": "BUKBGB22"
- },
- "BrnchId": {
- "Id": 12345,
- "Nm": "Oxford Street Branch",
- "PstlAdr": {
- "Ctry": "GB",
- "AdrLine": [
- "1 Oxford Street",
- "London",
- "UK"
]
- }
- }
- }
- }
- },
- "Assgne": {
- "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n",
- "title": "Party40Choice",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nIdentification of a person or an organisation.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
]
}
+ },
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Cd": "ADDR"
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
},
- {
- "required": [
- "Prtry"
- ]
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
}
- ],
- "example": {
- "Cd": "BIC"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "CCPT"
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
+ "required": [
+ "FinInstnId"
+ ],
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "Othr": {
+ "BrnchId": {
"Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
}
}
}
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
},
{
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
}
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
+ "DbtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
"Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "Agt": {
- "description": "Agent\nIdentification of a financial institution.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Prxy": {
+ "allOf": [
{
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
- "required": [
- "MmbId"
- ],
"example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "MmbId": 123456789
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
},
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
+ {
+ "description": "DebtorAccount\nAccount used to process a payment.\n"
+ }
+ ]
+ },
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
"Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
+ "FinInstnId"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "Issr": "BIC"
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
},
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
}
- }
+ ]
},
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
+ "CdtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
+ "required": [],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Pty"
- ]
- },
- {
- "required": [
- "Agt"
- ]
- }
- ],
- "example": {
- "Pty": {
- "Nm": "Name",
- "PstlAdr": {
- "Ctry": "US",
- "AdrLine": [
- "Line1",
- "Line2"
- ]
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- }
- }
- },
- "Agt": {
- "FinInstnId": {
- "BICFI": "BUKBGB22"
- },
- "BrnchId": {
- "Id": 12345,
- "Nm": "Oxford Street Branch",
- "PstlAdr": {
- "Ctry": "GB",
- "AdrLine": [
- "1 Oxford Street",
- "London",
- "UK"
- ]
- }
- }
- }
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm",
- "Assgnr",
- "Assgne"
- ],
- "example": {
- "MsgId": 123,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "Assgnr": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "Assgne": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- }
- }
- },
- "IdentificationInformation4": {
- "title": "IdentificationInformation4",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "FinInstnId"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
+ "FinInstnId"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
}
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
+ }
+ ]
+ },
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
"Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Ccy": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
},
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
},
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
+ {
+ "description": "CreditorAccount\nAccount to which a credit entry is made.\n"
}
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "Acct": {
- "description": "Account\nUnambiguous identification of the account of a party.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
"type": "object",
"properties": {
"Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
}
},
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": 1111
+ "Cd": "CH03"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "VrfctnOfTerms": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
+ "type": "string",
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
+ },
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IlpV4PrepPacket"
+ ]
+ },
+ {
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "SHA-256 signature of the terms\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Sh256Sgntr"
+ ]
+ }
+ ],
+ "example": {
+ "IlpV4PrepPacket": "1234567890ABCDEF"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ ]
}
},
"required": [
- "Id"
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "Dbtr",
+ "Cdtr"
],
"example": {
- "Tp": {
- "Cd": "IBAN"
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
},
- "Id": 123
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ }
+ },
+ "IntrBkSttlmAmt": {
+ "Amount": 123.45,
+ "Ccy": "EUR"
+ },
+ "Dbtr": {
+ "Nm": "Debtor Name"
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "Creditor Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "INSTRUCTION"
+ },
+ "Purp": {
+ "Cd": "CHAR"
+ },
+ "VrfctnOfTerms": {
+ "Cntt": "CONTENT",
+ "CnttTp": "PROPRIETARY"
+ }
}
+ },
+ {
+ "description": "Credit Transfer Transaction Information\n"
}
- },
- "example": {
+ ]
+ }
+ },
+ "required": [
+ "MsgId",
+ "CreDtTm",
+ "NbOfTxs",
+ "SttlmInf",
+ "CdtTrfTxInf"
+ ],
+ "example": {
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "TtlIntrBkSttlmAmt": {
+ "Ccy": "EUR",
+ "Value": 100
+ },
+ "SttlmInf": {
+ "SttlmMtd": "INDA",
+ "SttlmAcct": {
"Id": {
"IBAN": "BE71096123456769"
},
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
+ "Ccy": "EUR"
+ },
+ "SttlmAcctOwnr": {
+ "Nm": "Name"
+ },
+ "SttlmAcctSvcr": {
+ "Nm": "Name"
+ },
+ "SttlmAgt": {
+ "FinInstnId": {
+ "BICFI": "BIC"
}
}
},
- "Agt": {
- "description": "Agent\nFinancial institution servicing an account for a party.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "CtgyPurp": "CASH"
+ },
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": 12345,
+ "EndToEndId": 12345
+ },
+ "Amt": {
+ "InstdAmt": {
+ "Ccy": "EUR",
+ "Value": 100
+ }
+ },
+ "Cdtr": {
+ "Nm": "Name"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Ccy": "EUR"
+ },
+ "CdtrAgt": {
"FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
+ "BICFI": "BIC"
+ }
+ },
+ "CdtrAgtAcct": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Ccy": "EUR"
+ },
+ "RmtInf": {
+ "Ustrd": "Test"
+ }
+ }
+ }
+ },
+ "GroupHeader120": {
+ "title": "GroupHeader120",
+ "description": "Set of characteristics shared by all individual transactions included in the message.\n",
+ "type": "object",
+ "properties": {
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MessageIdentification\nDefinition: Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message.\nUsage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period.\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "CreationDateTime\nDate and time at which the message was created.\n"
+ }
+ ]
+ },
+ "TxInfAndSts": {
+ "allOf": [
+ {
+ "title": "PaymentTransaction163",
+ "description": "Provides further details on the original transactions, to which the status report message refers.\n",
+ "type": "object",
+ "properties": {
+ "StsId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ {
+ "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n"
+ }
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "OrgnlInstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "BldgNm": {
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n"
+ }
+ ]
+ },
+ "OrgnlEndToEndId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -81603,47 +97231,1228 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n"
+ }
+ ]
+ },
+ "OrgnlTxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n"
+ }
+ ]
+ },
+ "OrgnlUETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
"type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
},
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ {
+ "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n"
+ }
+ ]
+ },
+ "TxSts": {
+ "allOf": [
+ {
+ "title": "ExternalPaymentTransactionStatus1Code",
+ "description": "Specifies the external payment transaction status code.",
"type": "string",
"minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "maxLength": 4,
+ "example": 1234
},
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ {
+ "description": "Specifies the status of the transaction.\n"
+ }
+ ]
+ },
+ "StsRsnInf": {
+ "allOf": [
+ {
+ "title": "StatusReasonInformation14",
+ "description": "Unsure on description.\n",
+ "type": "object",
+ "properties": {
+ "Orgtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Originator\nParty that issues the status.\n"
+ }
+ ]
+ },
+ "Rsn": {
+ "allOf": [
+ {
+ "title": "StatusReason6Choice",
+ "description": "Specifies the reason for the status.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalStatusReason1Code",
+ "description": "Specifies the external status reason code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nReason for the status, as published in an external reason code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nReason for the status, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "AGNT"
+ }
+ },
+ {
+ "description": "Reason\nSpecifies the reason for the status report.\n"
+ }
+ ]
+ },
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max105Text",
+ "description": "Specifies a character string with a maximum length of 105 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 105,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\nAdditional information about the status report.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Orgtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "SubDepartment",
+ "StrtNm": "StreetName",
+ "BldgNb": "BuildingNumber",
+ "PstCd": "PostCode",
+ "TwnNm": "TownName",
+ "CtrySubDvsn": "CountrySubDivision",
+ "Ctry": "Country"
+ }
+ },
+ "Rsn": {
+ "Cd": "AGNT"
+ },
+ "AddtlInf": "AdditionalInformation"
+ }
},
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Information concerning the reason for the status.\n"
+ }
+ ]
+ },
+ "AccptncDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
},
- "TwnLctnNm": {
+ {
+ "description": "Date and time at which the status was accepted.\n"
+ }
+ ]
+ },
+ "AcctSvcrRef": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -81651,7 +98460,14 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "DstrctNm": {
+ {
+ "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -81659,215 +98475,521 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n"
+ }
+ ]
+ },
+ "ExctnConf": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n"
+ }
+ ]
+ },
+ "SplmtryData": {
+ "allOf": [
+ {
+ "title": "SupplementaryData1",
+ "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n",
+ "type": "object",
+ "properties": {
+ "PlcAndNm": {
+ "allOf": [
+ {
+ "title": "Max350Text",
+ "description": "Specifies a character string with a maximum length of 350 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 350,
+ "example": 350
+ },
+ {
+ "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n"
+ }
+ ]
+ },
+ "Envlp": {
+ "allOf": [
+ {
+ "title": "SupplementaryDataEnvelope1",
+ "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
+ "type": "object"
+ },
+ {
+ "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Envlp"
+ ],
+ "example": {
+ "PlcAndNm": "Additional information",
+ "Envlp": {
+ "Cd": "CH03",
+ "Prtry": "Additional information"
+ }
+ }
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
+ }
+ },
+ "example": {
+ "StsId": 12345,
+ "OrgnlInstrId": 12345,
+ "OrgnlEndToEndId": 12345,
+ "OrgnlTxId": 12345,
+ "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
+ "TxSts": "RJCT",
+ "StsRsnInf": {
+ "Rsn": "RSN",
+ "AddtlInf": "ADDITIONAL"
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
+ "AccptncDtTm": "2020-01-01T00:00:00Z",
+ "AcctSvcrRef": "ACCTSVCRREF",
+ "ClrSysRef": "CLRSYSREF",
+ "ExctnConf": "1234567890ABCDEF",
+ "SplmtryData": {
+ "PlcAndNm": "PLACE",
+ "Envlp": "ENVELOPE"
+ }
+ }
+ },
+ {
+ "description": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MsgId",
+ "CreDtTm"
+ ],
+ "example": {
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "TxInfAndSts": {
+ "StsId": 12345,
+ "OrgnlInstrId": 12345,
+ "OrgnlEndToEndId": 12345,
+ "OrgnlTxId": 12345,
+ "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
+ "TxSts": "RJCT",
+ "StsRsnInf": {
+ "Rsn": "RSN",
+ "AddtlInf": "ADDITIONAL"
+ },
+ "AccptncDtTm": "2020-01-01T00:00:00Z",
+ "AcctSvcrRef": "ACCTSVCRREF",
+ "ClrSysRef": "CLRSYSREF",
+ "ExctnConf": "1234567890ABCDEF",
+ "SplmtryData": {
+ "PlcAndNm": "PLACE",
+ "Envlp": "ENVELOPE"
+ }
+ }
+ }
+ },
+ "GroupHeader129": {
+ "title": "GroupHeader129",
+ "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n",
+ "type": "object",
+ "properties": {
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Message Identification\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Creation Date and Time\n"
+ }
+ ]
+ },
+ "PmtInstrXpryDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Payment Instruction Expiry Date and Time\n"
+ }
+ ]
+ },
+ "NbOfTxs": {
+ "allOf": [
+ {
+ "title": "Max15NumericText",
+ "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
+ "type": "string",
+ "pattern": "^[0-9]{1,15}$",
+ "example": 123456789012345
+ },
+ {
+ "description": "Number of Transactions\n"
+ }
+ ]
+ },
+ "SttlmInf": {
+ "allOf": [
+ {
+ "title": "SettlementInstruction15",
+ "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
+ "type": "object",
+ "properties": {
+ "SttlmMtd": {
+ "title": "SettlementMethod1Code",
+ "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n",
+ "type": "string",
+ "enum": [
+ "INDA",
+ "INGA",
+ "COVE",
+ "CLRG"
+ ],
+ "example": "CLRG"
+ },
+ "PmtTpInf": {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
}
},
- "required": [
- "Id"
- ],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
},
- "Issr": "BIC"
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
}
}
},
+ "required": [
+ "SttlmMtd"
+ ],
"example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
+ "SttlmMtd": "INDA",
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "SvcLvl": {
+ "Cd": "SEPA"
},
- "Issr": 123
+ "LclInstrm": {
+ "Cd": "CH03"
+ },
+ "CtgyPurp": {
+ "Cd": "SUPP"
+ },
+ "Cdtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "AdrLine": "Address",
+ "Ctry": "CH"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN",
+ "Issr": "BIC"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "CH",
+ "CtctDtls": {
+ "Nm": "Name",
+ "PhneNb": 123,
+ "EmailAdr": null
+ }
+ }
}
}
},
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
+ {
+ "description": "Settlement Information\n"
+ }
+ ]
+ },
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction67",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
"type": "object",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Issr": {
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
+ },
+ "EndToEndId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -81875,1214 +98997,2430 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "UETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
]
}
+ },
+ "required": [
+ "TxId"
],
"example": {
- "Cd": "ADDR"
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
}
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- }
- },
- "example": {
- "Pty": {
- "Id": {
- "OrgId": {
- "AnyBIC": {
- "BICFI": "BICFI"
- }
- }
- },
- "CtryOfRes": "FI"
- },
- "Acct": {
- "Id": {
- "IBAN": "FI2112345600000785"
- }
- },
- "Agt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- }
- }
- },
- "IdentificationVerificationIndicator": {
- "title": "IdentificationVerificationIndicator",
- "type": "boolean",
- "example": true,
- "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n"
- },
- "Instruction4Code": {
- "title": "Instruction4Code",
- "description": "Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).\nPHOA PhoneNextAgent Please advise/contact next agent by phone.\nTELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n",
- "type": "string",
- "enum": [
- "PHOA",
- "TELA"
- ],
- "example": "PHOA"
- },
- "InstructionForCreditorAgent3": {
- "title": "InstructionForCreditorAgent3",
- "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "InstructionForNextAgent1": {
- "title": "InstructionForNextAgent1",
- "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
- "title": "Instruction4Code",
- "type": "string",
- "enum": [
- "PHOA",
- "TELA"
- ],
- "example": "PHOA"
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone"
- }
- },
- "LEIIdentifier": {
- "title": "LEIIdentifier",
- "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "LocalInstrument2Choice": {
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Max105Text": {
- "title": "Max105Text",
- "description": "Specifies a character string with a maximum length of 105 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 105,
- "example": 12345
- },
- "Max10Text": {
- "title": "Max10Text",
- "description": "Specifies a character string with a maximum length of 10 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Max128Text": {
- "title": "Max128Text",
- "description": "Specifies a character string with a maximum length of 128 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- },
- "Max140Text": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Max15NumericText": {
- "title": "Max15NumericText",
- "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
- "type": "string",
- "pattern": "^[0-9]{1,15}$",
- "example": 123456789012345
- },
- "Max16Text": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Max2048Text": {
- "title": "Max2048Text",
- "description": "Specifies a character string with a maximum length of 2048 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "Max256Text": {
- "title": "Max256Text",
- "description": "Specifies a character string with a maximum length of 256 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "Max34Text": {
- "title": "Max34Text",
- "description": "Specifies a character string with a maximum length of 34 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "Max350Text": {
- "title": "Max350Text",
- "description": "Specifies a character string with a maximum length of 350 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 350,
- "example": 350
- },
- "Max35Text": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Max4Text": {
- "title": "Max4Text",
- "description": "Specifies a character string with a maximum length of 4 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Max70Text": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "NamePrefix2Code": {
- "description": "Specifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Number": {
- "title": "Number",
- "type": "string",
- "pattern": "^[\\d\\-\\.\\,]{1,18}$",
- "example": 256
- },
- "OrganisationIdentification29": {
- "title": "OrganisationIdentification29",
- "description": "Unique and unambiguous way to identify an organisation.\n",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ ]
+ },
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
+ "type": "object",
+ "properties": {
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
+ },
+ {
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "InstdAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "OrganisationIdentification39": {
- "title": "OrganisationIdentification39",
- "description": "Unique and unambiguous way to identify an organisation.\n",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "XchgRate": {
+ "allOf": [
+ {
+ "title": "BaseOneRate",
+ "type": "string",
+ "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 0.7
+ },
+ {
+ "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "ChrgBr": {
+ "title": "ChargeBearerType1Code",
+ "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n",
+ "type": "string",
+ "enum": [
+ "DEBT",
+ "CRED",
+ "SHAR",
+ "SLEV"
+ ],
+ "example": "DEBT"
+ },
+ "ChrgsInf": {
+ "allOf": [
+ {
+ "title": "Charges16",
+ "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n",
+ "type": "object",
+ "properties": {
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\nTransaction charges to be paid by the charge bearer.\n"
+ }
+ ]
+ },
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ChargeType3Choice",
+ "description": "ChargeType3Choice\nSpecifies the type of charge.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalChargeType1Code",
+ "description": "Specifies the type of charge applied to the transaction.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCharge type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification3",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "Type\nDefines the type of charges.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt",
+ "Agt"
+ ],
+ "example": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
+ }
+ },
+ {
+ "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "OrganisationIdentificationSchemeName1Choice": {
- "title": "OrganisationIdentificationSchemeName1Choice",
- "description": "Choice of format for the organisation identification.\n",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "OtherContact1": {
- "title": "OtherContact1",
- "description": "Communication device number or electronic address used for communication.\n",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PacsError_FIToFIPaymentStatusReportV15": {
- "title": "PacsError_FIToFIPaymentStatusReportV15",
- "type": "object",
- "properties": {
- "GrpHdr": {
- "title": "GroupHeader120",
- "description": "Set of characteristics shared by all individual transactions included in the message.\n",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "TxInfAndSts": {
- "description": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n",
- "title": "PaymentTransaction163",
- "type": "object",
- "properties": {
- "StsId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlInstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlEndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlTxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlUETR": {
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "TxSts": {
- "title": "ExternalPaymentTransactionStatus1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
},
- "StsRsnInf": {
- "title": "StatusReasonInformation14",
- "description": "Unsure on description.\n",
- "type": "object",
- "properties": {
- "Orgtr": {
- "description": "Originator\nParty that issues the status.",
+ "Dbtr": {
+ "allOf": [
+ {
"title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
"Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
},
"PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "allOf": [
+ {
+ "title": "PostalAddress27",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "example": "ADDR"
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
+ "OrgId"
]
},
{
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
+ "PrvtId"
]
}
],
"example": {
- "Cd": "ADDR"
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
"title": "CountryCode",
"type": "string",
"pattern": "^[A-Z]{2,2}$",
"example": "US",
"description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
"type": "object",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
},
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
"title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 256,
"example": 256
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
},
- "PrvcOfBirth": {
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -83090,7 +101428,14 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "CityOfBirth": {
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -83098,290 +101443,117 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 256,
- "example": 256
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
]
}
+ },
+ "required": [
+ "ChanlTp"
],
"example": {
- "Cd": "CCPT"
+ "ChanlTp": "PHON",
+ "Id": 1234567890
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "OtherContact\nContact details in another form.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
},
- "Issr": "BIC"
- }
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
}
},
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
},
{
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
}
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
+ ]
}
},
+ "required": [
+ "Id"
+ ],
"example": {
"Nm": "John Doe",
"PstlAdr": {
@@ -83413,1628 +101585,3167 @@
"PhneNb": "+123-123-321",
"MobNb": "+123-123-321",
"FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "Rsn": {
- "description": "Reason\nSpecifies the reason for the status report.",
- "title": "StatusReason6Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nReason for the status, as published in an external reason code list.\n",
- "title": "ExternalStatusReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
+ "EmailAdr": "example@example.com"
}
- ],
- "example": {
- "Cd": "AGNT"
- }
- },
- "AddtlInf": {
- "description": "AdditionalInformation\nAdditional information about the status report.",
- "title": "Max105Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 105,
- "example": 12345
- }
- },
- "example": {
- "Orgtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "SubDepartment",
- "StrtNm": "StreetName",
- "BldgNb": "BuildingNumber",
- "PstCd": "PostCode",
- "TwnNm": "TownName",
- "CtrySubDvsn": "CountrySubDivision",
- "Ctry": "Country"
}
},
- "Rsn": {
- "Cd": "AGNT"
- },
- "AddtlInf": "AdditionalInformation"
- }
- },
- "AccptncDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "AcctSvcrRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "ExctnConf": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- },
- "SplmtryData": {
- "title": "SupplementaryData1",
- "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n",
- "type": "object",
- "properties": {
- "PlcAndNm": {
- "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n",
- "title": "Max350Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 350,
- "example": 350
- },
- "Envlp": {
- "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
- "title": "SupplementaryDataEnvelope1",
- "type": "object"
- }
- },
- "required": [
- "Envlp"
- ],
- "example": {
- "PlcAndNm": "Additional information",
- "Envlp": {
- "Cd": "CH03",
- "Prtry": "Additional information"
+ {
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
}
- }
- }
- },
- "example": {
- "StsId": 12345,
- "OrgnlInstrId": 12345,
- "OrgnlEndToEndId": 12345,
- "OrgnlTxId": 12345,
- "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
- "TxSts": "RJCT",
- "StsRsnInf": {
- "Rsn": "RSN",
- "AddtlInf": "ADDITIONAL"
+ ]
},
- "AccptncDtTm": "2020-01-01T00:00:00Z",
- "AcctSvcrRef": "ACCTSVCRREF",
- "ClrSysRef": "CLRSYSREF",
- "ExctnConf": "1234567890ABCDEF",
- "SplmtryData": {
- "PlcAndNm": "PLACE",
- "Envlp": "ENVELOPE"
- }
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm"
- ],
- "example": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "TxInfAndSts": {
- "StsId": 12345,
- "OrgnlInstrId": 12345,
- "OrgnlEndToEndId": 12345,
- "OrgnlTxId": 12345,
- "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
- "TxSts": "RJCT",
- "StsRsnInf": {
- "Rsn": "RSN",
- "AddtlInf": "ADDITIONAL"
- },
- "AccptncDtTm": "2020-01-01T00:00:00Z",
- "AcctSvcrRef": "ACCTSVCRREF",
- "ClrSysRef": "CLRSYSREF",
- "ExctnConf": "1234567890ABCDEF",
- "SplmtryData": {
- "PlcAndNm": "PLACE",
- "Envlp": "ENVELOPE"
- }
- }
- }
- },
- "TxInfAndSts": {
- "title": "PaymentTransaction163",
- "description": "Provides further details on the original transactions, to which the status report message refers.\n",
- "type": "object",
- "properties": {
- "StsId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlInstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlEndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlTxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlUETR": {
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "TxSts": {
- "title": "ExternalPaymentTransactionStatus1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "StsRsnInf": {
- "title": "StatusReasonInformation14",
- "description": "Unsure on description.\n",
- "type": "object",
- "properties": {
- "Orgtr": {
- "description": "Originator\nParty that issues the status.",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ "DbtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "example": "ADDR"
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "Id"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
},
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
+ {
+ "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n"
+ }
+ ]
+ },
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
{
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
- "required": [
- "Id"
- ],
+ "required": [],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
}
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
"Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "LEI": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
}
},
- "required": [
- "Id"
- ],
"example": {
"Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
]
}
+ },
+ "required": [
+ "FinInstnId"
],
"example": {
- "OrgId": {
- "AnyBIC": "BIC"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
}
}
}
},
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
+ }
+ ]
+ },
+ "CdtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
},
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
+ ]
},
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "Rsn": {
- "description": "Reason\nSpecifies the reason for the status report.",
- "title": "StatusReason6Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nReason for the status, as published in an external reason code list.\n",
- "title": "ExternalStatusReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "AGNT"
- }
- },
- "AddtlInf": {
- "description": "AdditionalInformation\nAdditional information about the status report.",
- "title": "Max105Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 105,
- "example": 12345
- }
- },
- "example": {
- "Orgtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "SubDepartment",
- "StrtNm": "StreetName",
- "BldgNb": "BuildingNumber",
- "PstCd": "PostCode",
- "TwnNm": "TownName",
- "CtrySubDvsn": "CountrySubDivision",
- "Ctry": "Country"
- }
- },
- "Rsn": {
- "Cd": "AGNT"
- },
- "AddtlInf": "AdditionalInformation"
- }
- },
- "AccptncDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "AcctSvcrRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "ExctnConf": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- },
- "SplmtryData": {
- "title": "SupplementaryData1",
- "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n",
- "type": "object",
- "properties": {
- "PlcAndNm": {
- "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n",
- "title": "Max350Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 350,
- "example": 350
- },
- "Envlp": {
- "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
- "title": "SupplementaryDataEnvelope1",
- "type": "object"
- }
- },
- "required": [
- "Envlp"
- ],
- "example": {
- "PlcAndNm": "Additional information",
- "Envlp": {
- "Cd": "CH03",
- "Prtry": "Additional information"
- }
- }
- }
- },
- "example": {
- "StsId": 12345,
- "OrgnlInstrId": 12345,
- "OrgnlEndToEndId": 12345,
- "OrgnlTxId": 12345,
- "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
- "TxSts": "RJCT",
- "StsRsnInf": {
- "Rsn": "RSN",
- "AddtlInf": "ADDITIONAL"
- },
- "AccptncDtTm": "2020-01-01T00:00:00Z",
- "AcctSvcrRef": "ACCTSVCRREF",
- "ClrSysRef": "CLRSYSREF",
- "ExctnConf": "1234567890ABCDEF",
- "SplmtryData": {
- "PlcAndNm": "PLACE",
- "Envlp": "ENVELOPE"
- }
- }
- },
- "SplmtryData": {
- "title": "SupplementaryData1",
- "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n",
- "type": "object",
- "properties": {
- "PlcAndNm": {
- "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n",
- "title": "Max350Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 350,
- "example": 350
- },
- "Envlp": {
- "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
- "title": "SupplementaryDataEnvelope1",
- "type": "object"
- }
- },
- "required": [
- "Envlp"
- ],
- "example": {
- "PlcAndNm": "Additional information",
- "Envlp": {
- "Cd": "CH03",
- "Prtry": "Additional information"
- }
- }
- }
- },
- "required": [
- "GrpHdr"
- ],
- "example": {
- "GrpHdr": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "SttlmInf": {
- "SttlmMtd": "INDA",
- "SttlmDt": "2020-01-01"
- },
- "InstgAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "InstdAgt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- }
- },
- "TxInfAndSts": {
- "OrgnlInstrId": 12345,
- "OrgnlEndToEndId": 12345,
- "TxSts": "RJCT",
- "StsRsnInf": {
- "Rsn": "RSN",
- "AddtlInf": "ADDITIONAL"
- }
- },
- "SplmtryData": {
- "PlcAndNm": "PLACE",
- "Envlp": "ENVELOPE"
- }
- }
- },
- "PacsStatus_FIToFIPaymentStatusReportV15": {
- "title": "PacsStatus_FIToFIPaymentStatusReportV15",
- "description": "Unsure on description.\n",
- "type": "object",
- "properties": {
- "GrpHdr": {
- "title": "GroupHeader120",
- "description": "Set of characteristics shared by all individual transactions included in the message.\n",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "TxInfAndSts": {
- "description": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n",
- "title": "PaymentTransaction163",
- "type": "object",
- "properties": {
- "StsId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlInstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlEndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlTxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlUETR": {
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "TxSts": {
- "title": "ExternalPaymentTransactionStatus1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
+ }
+ ]
},
- "StsRsnInf": {
- "title": "StatusReasonInformation14",
- "description": "Unsure on description.\n",
- "type": "object",
- "properties": {
- "Orgtr": {
- "description": "Originator\nParty that issues the status.",
+ "Cdtr": {
+ "allOf": [
+ {
"title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
"Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
},
"PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "allOf": [
+ {
+ "title": "PostalAddress27",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "AdrTp": {
+ "title": "AddressType3Choice",
"type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "Id",
- "Issr"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Cd": "ADDR"
}
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
+ "OrgId"
]
},
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
},
- "Ctry": {
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
"title": "CountryCode",
"type": "string",
"pattern": "^[A-Z]{2,2}$",
"example": "US",
"description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
"type": "object",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
},
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
"title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 256,
"example": 256
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
},
- "PrvcOfBirth": {
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -85042,7 +104753,14 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "CityOfBirth": {
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -85050,290 +104768,117 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 256,
- "example": 256
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
]
}
+ },
+ "required": [
+ "ChanlTp"
],
"example": {
- "Cd": "CCPT"
+ "ChanlTp": "PHON",
+ "Id": 1234567890
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "OtherContact\nContact details in another form.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
},
- "Issr": "BIC"
- }
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
}
},
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
},
{
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
}
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
+ ]
}
},
+ "required": [
+ "Id"
+ ],
"example": {
"Nm": "John Doe",
"PstlAdr": {
@@ -85356,1325 +104901,1261 @@
"Dt": "2018-01-01",
"CityOfBirth": "City"
}
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "Rsn": {
- "description": "Reason\nSpecifies the reason for the status report.",
- "title": "StatusReason6Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nReason for the status, as published in an external reason code list.\n",
- "title": "ExternalStatusReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ }
},
- {
- "required": [
- "Prtry"
- ]
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
}
- ],
- "example": {
- "Cd": "AGNT"
- }
- },
- "AddtlInf": {
- "description": "AdditionalInformation\nAdditional information about the status report.",
- "title": "Max105Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 105,
- "example": 12345
- }
- },
- "example": {
- "Orgtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "SubDepartment",
- "StrtNm": "StreetName",
- "BldgNb": "BuildingNumber",
- "PstCd": "PostCode",
- "TwnNm": "TownName",
- "CtrySubDvsn": "CountrySubDivision",
- "Ctry": "Country"
}
},
- "Rsn": {
- "Cd": "AGNT"
- },
- "AddtlInf": "AdditionalInformation"
- }
- },
- "AccptncDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "AcctSvcrRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "ExctnConf": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- },
- "SplmtryData": {
- "title": "SupplementaryData1",
- "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n",
- "type": "object",
- "properties": {
- "PlcAndNm": {
- "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n",
- "title": "Max350Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 350,
- "example": 350
- },
- "Envlp": {
- "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
- "title": "SupplementaryDataEnvelope1",
- "type": "object"
- }
- },
- "required": [
- "Envlp"
- ],
- "example": {
- "PlcAndNm": "Additional information",
- "Envlp": {
- "Cd": "CH03",
- "Prtry": "Additional information"
- }
- }
- }
- },
- "example": {
- "StsId": 12345,
- "OrgnlInstrId": 12345,
- "OrgnlEndToEndId": 12345,
- "OrgnlTxId": 12345,
- "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
- "TxSts": "RJCT",
- "StsRsnInf": {
- "Rsn": "RSN",
- "AddtlInf": "ADDITIONAL"
- },
- "AccptncDtTm": "2020-01-01T00:00:00Z",
- "AcctSvcrRef": "ACCTSVCRREF",
- "ClrSysRef": "CLRSYSREF",
- "ExctnConf": "1234567890ABCDEF",
- "SplmtryData": {
- "PlcAndNm": "PLACE",
- "Envlp": "ENVELOPE"
- }
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm"
- ],
- "example": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "TxInfAndSts": {
- "StsId": 12345,
- "OrgnlInstrId": 12345,
- "OrgnlEndToEndId": 12345,
- "OrgnlTxId": 12345,
- "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
- "TxSts": "RJCT",
- "StsRsnInf": {
- "Rsn": "RSN",
- "AddtlInf": "ADDITIONAL"
- },
- "AccptncDtTm": "2020-01-01T00:00:00Z",
- "AcctSvcrRef": "ACCTSVCRREF",
- "ClrSysRef": "CLRSYSREF",
- "ExctnConf": "1234567890ABCDEF",
- "SplmtryData": {
- "PlcAndNm": "PLACE",
- "Envlp": "ENVELOPE"
- }
- }
- }
- }
- },
- "required": [
- "GrpHdr"
- ],
- "example": {
- "GrpHdr": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "TxInfAndSts": {
- "StsId": 12345,
- "OrgnlInstrId": 12345,
- "OrgnlEndToEndId": 12345,
- "OrgnlTxId": 12345,
- "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
- "TxSts": "RJCT",
- "StsRsnInf": {
- "Rsn": "RSN",
- "AddtlInf": "ADDITIONAL"
- },
- "AccptncDtTm": "2020-01-01T00:00:00Z",
- "AcctSvcrRef": "ACCTSVCRREF",
- "ClrSysRef": "CLRSYSREF",
- "ExctnConf": "1234567890ABCDEF",
- "SplmtryData": {
- "PlcAndNm": "PLACE",
- "Envlp": "ENVELOPE"
- }
- }
- }
- }
- },
- "Party38Choice": {
- "title": "Party38Choice",
- "description": "Nature or use of the account.\n",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
{
- "required": [
- "Prtry"
- ]
+ "description": "Creditor\nParty to which an amount of money is due.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "CdtrAcct": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "Party40Choice": {
- "title": "Party40Choice",
- "description": "Identification of a person, an organisation or a financial institution.\n",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nIdentification of a person or an organisation.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
"Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
"type": "object",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
"type": "string",
"minLength": 1,
"maxLength": 4,
"example": 1234
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
}
- },
- "oneOf": [
+ ]
+ }
+ },
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "InstrForNxtAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForNextAgent1",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Instruction4Code",
+ "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n",
+ "type": "string",
+ "enum": [
+ "PHOA",
+ "TELA"
+ ],
+ "example": "PHOA"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
}
},
- "required": [
- "Id"
- ],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
}
+ },
+ {
+ "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n"
}
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
+ ]
},
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
"type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
],
"example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
+ "Cd": "CH03"
}
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
+ }
+ ]
+ },
+ "RgltryRptg": {
+ "allOf": [
+ {
+ "title": "RegulatoryReporting3",
+ "description": "Information needed due to regulatory and/or statutory requirements.\n",
"type": "object",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
+ "DbtCdtRptgInd": {
+ "allOf": [
+ {
+ "title": "RegulatoryReportingType1Code",
+ "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "enum": [
+ "CRED",
+ "DEBT",
+ "BOTH"
+ ],
+ "example": "BOTH"
+ },
+ {
+ "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n"
+ }
+ ]
+ },
+ "Authrty": {
+ "allOf": [
+ {
+ "title": "RegulatoryAuthority2",
+ "description": "Information about an entity requiring the regulatory reporting information.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Authority\n\nEntity requiring the regulatory reporting information.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Dtls": {
+ "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
+ "anyOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "items": {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ "type": "array"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
- "required": [
- "Id"
- ],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
+ "DbtCdtRptgInd": "CRED",
+ "Authrty": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
},
- "Issr": "BIC"
+ "Dtls": {
+ "Cd": "A1",
+ "Inf": "Mandatory regulatory information"
+ }
}
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ {
+ "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n"
}
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "Agt": {
- "description": "Agent\nIdentification of a financial institution.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "Tax": {
+ "allOf": [
+ {
+ "title": "TaxData1",
+ "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "TaxParty1",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the creditor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT"
+ }
+ },
+ {
+ "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
+ },
+ {
+ "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "UltmtDbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
},
- "Issr": {
+ {
+ "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n"
+ }
+ ]
+ },
+ "AdmstnZone": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -86682,1082 +106163,2076 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n"
+ }
+ ]
+ },
+ "RefNb": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n"
+ }
+ ]
+ },
+ "Mtd": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "TtlTaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "TtlTaxAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "format": "date",
+ "example": "2013-03-07"
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Date\n\nDate by which tax is due.\n"
+ }
+ ]
+ },
+ "SeqNb": {
+ "allOf": [
+ {
+ "title": "Number",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^[\\d\\-\\.\\,]{1,18}$",
+ "example": 256
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "SequenceNumber\n\nSequential number of the tax report.\n"
+ }
+ ]
+ },
+ "Rcrd": {
+ "description": "Record\n\nDetails of the tax record.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ "type": "array"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "example": {
+ "Cdtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
},
- {
- "required": [
- "Prtry"
- ]
+ "Dbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "UltmtDbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "AdmstnZone": "CH",
+ "RefNb": 12345,
+ "Mtd": "A",
+ "TtlTaxblBaseAmt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "TtlTaxAmt": {
+ "Ccy": "CHF",
+ "Amt": 100
+ },
+ "Dt": "2018-01-01",
+ "SeqNb": 1,
+ "Rcrd": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
}
- ],
- "example": {
- "Cd": "ADDR"
}
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Tax\nProvides details on the tax.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Pty"
- ]
- },
- {
- "required": [
- "Agt"
- ]
- }
- ],
- "example": {
- "Pty": {
- "Nm": "Name",
- "PstlAdr": {
- "Ctry": "US",
- "AdrLine": [
- "Line1",
- "Line2"
- ]
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- }
- }
- },
- "Agt": {
- "FinInstnId": {
- "BICFI": "BUKBGB22"
- },
- "BrnchId": {
- "Id": 12345,
- "Nm": "Oxford Street Branch",
- "PstlAdr": {
- "Ctry": "GB",
- "AdrLine": [
- "1 Oxford Street",
- "London",
- "UK"
- ]
- }
- }
- }
- }
- },
- "Party52Choice": {
- "title": "Party52Choice",
- "description": "NOTE: Unsure on the description.\n",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "VrfctnOfTerms": {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
+ "type": "string",
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
+ },
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
+ "IlpV4PrepPacket"
]
},
{
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "SHA-256 signature of the terms\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
+ "Sh256Sgntr"
]
}
],
"example": {
- "Cd": "BIC"
+ "IlpV4PrepPacket": "1234567890ABCDEF"
}
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
}
},
"required": [
- "Id"
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "ChrgBr",
+ "Dbtr",
+ "DbtrAgt",
+ "CdtrAgt",
+ "Cdtr"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
},
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ },
+ "SeqTp": "SEQTP"
},
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "IntrBkSttlmAmt": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
+ "InstdAmt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
+ "XchgRate": 123.45,
+ "ChrgBr": "SHAR",
+ "ChrgsInf": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
},
- {
- "required": [
- "Prtry"
- ]
+ "FinInstnId": {
+ "BICFI": "BICFI"
}
- ],
- "example": {
- "Cd": "CCPT"
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
+ },
+ "Dbtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
},
- "Issr": "BIC"
+ "InstrForCdtrAgt": {
+ "Cd": "CODE"
+ },
+ "InstrForNxtAgt": {
+ "Cd": "CODE"
+ },
+ "Purp": {
+ "Cd": "CASH"
+ },
+ "RgltryRptg": {
+ "Dbtr": true,
+ "Cdtr": true
+ },
+ "Tax": "Cdtr"
}
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ {
+ "description": "Credit Transfer Transaction Information\n"
}
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
]
}
+ },
+ "required": [
+ "MsgId",
+ "CreDtTm",
+ "NbOfTxs",
+ "SttlmInf",
+ "CdtTrfTxInf"
],
"example": {
- "OrgId": {
- "AnyBIC": "BIC"
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "SttlmInf": {
+ "SttlmMtd": "INDA",
+ "SttlmAcct": {
+ "Id": {
+ "IBAN": 123
+ }
+ },
+ "SttlmAcctOwnr": {
+ "Nm": "John Doe"
+ },
+ "SttlmAcctSvcr": {
+ "BICFI": 123
+ }
},
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": 123,
+ "EndToEndId": 123
+ },
+ "PmtTpInf": {
+ "InstrPrty": "NORM"
+ },
+ "InstdAmt": {
+ "Amt": 123,
+ "Ccy": "EUR"
+ },
+ "ChrgBr": "SLEV",
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": 123
+ }
+ },
+ "Cdtr": {
+ "Nm": "John Doe"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": 123
+ }
+ },
+ "RmtInf": {
+ "Ustrd": "Test"
}
}
}
},
- "PartyIdentification135": {
- "title": "PartyIdentification135",
- "description": "Specifies the identification of a person or an organisation.\n",
+ "IBAN2007Identifier": {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ "ISODate": {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ "ISODateTime": {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ "ISOYear": {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ "IdentificationAssignment3": {
+ "title": "IdentificationAssignment3",
"type": "object",
+ "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n",
"properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
+ "MsgId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -87765,1367 +108240,4926 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
+ {
+ "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
"type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
+ "Assgnr": {
+ "allOf": [
+ {
+ "title": "Party40Choice",
+ "description": "Identification of a person, an organisation or a financial institution.\n",
"type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "Pty": {
+ "allOf": [
{
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Party\nIdentification of a person or an organisation.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
}
},
"required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ "Pty"
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
+ {
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "Agt": {
+ "allOf": [
{
+ "title": "BranchAndFinancialInstitutionIdentification6",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Agent\nIdentification of a financial institution.\n"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
+ "Agt"
+ ]
}
- },
+ ],
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "Pty": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "Ctry": "US",
+ "AdrLine": [
+ "Line1",
+ "Line2"
+ ]
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ }
+ }
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BUKBGB22"
+ },
+ "BrnchId": {
+ "Id": 12345,
+ "Nm": "Oxford Street Branch",
+ "PstlAdr": {
+ "Ctry": "GB",
+ "AdrLine": [
+ "1 Oxford Street",
+ "London",
+ "UK"
+ ]
+ }
}
}
}
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
},
{
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
+ "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n"
}
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "PartyIdentification272": {
- "title": "PartyIdentification272",
- "description": "Specifies the identification of a person or an organisation.\n",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "Assgne": {
+ "allOf": [
+ {
+ "title": "Party40Choice",
+ "description": "Identification of a person, an organisation or a financial institution.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Party\nIdentification of a person or an organisation.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Pty"
]
},
{
+ "properties": {
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Agent\nIdentification of a financial institution.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
+ "Agt"
]
}
],
"example": {
- "Cd": "ADDR"
+ "Pty": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "Ctry": "US",
+ "AdrLine": [
+ "Line1",
+ "Line2"
+ ]
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ }
+ }
+ },
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BUKBGB22"
+ },
+ "BrnchId": {
+ "Id": 12345,
+ "Nm": "Oxford Street Branch",
+ "PstlAdr": {
+ "Ctry": "GB",
+ "AdrLine": [
+ "1 Oxford Street",
+ "London",
+ "UK"
+ ]
+ }
+ }
+ }
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MsgId",
+ "CreDtTm",
+ "Assgnr",
+ "Assgne"
+ ],
+ "example": {
+ "MsgId": 123,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "Assgnr": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
}
},
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
+ "Assgne": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ }
+ }
+ },
+ "IdentificationInformation4": {
+ "title": "IdentificationInformation4",
+ "type": "object",
+ "description": "Information that locates and identifies a specific party or account.\n",
+ "properties": {
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 256,
- "example": 256
+ "maxLength": 140,
+ "example": 12345
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Prtry": {
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
- {
- "required": [
- "Prtry"
- ]
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
- ],
+ },
"example": {
- "Cd": "BIC"
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
+ "OrgId"
]
},
{
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
+ "PrvtId"
]
}
],
"example": {
- "Cd": "CCPT"
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ ]
},
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "PaymentIdentification13": {
- "title": "PaymentIdentification13",
- "description": "Provides further means of referencing a payment transaction.\n",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PaymentTransaction163": {
- "title": "PaymentTransaction163",
- "description": "Provides further details on the original transactions, to which the status report message refers.\n",
- "type": "object",
- "properties": {
- "StsId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlInstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlEndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlTxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "OrgnlUETR": {
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "TxSts": {
- "title": "ExternalPaymentTransactionStatus1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "StsRsnInf": {
- "title": "StatusReasonInformation14",
- "description": "Unsure on description.\n",
- "type": "object",
- "properties": {
- "Orgtr": {
- "description": "Originator\nParty that issues the status.",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
},
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "Issr": {
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -89133,115 +113167,437 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n"
+ }
+ ]
+ },
+ "Acct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
}
- },
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "ADDR"
+ "Cd": "CACC"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "Room": {
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
"title": "Max70Text",
"description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
@@ -89249,209 +113605,710 @@
"maxLength": 70,
"example": 1.2345678901234567e+99
},
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
+ ]
+ }
+ },
+ "example": {
"Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
+ },
+ {
+ "description": "Account\nUnambiguous identification of the account of a party.\n"
+ }
+ ]
+ },
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
},
"LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 256,
- "example": 256
+ "maxLength": 140,
+ "example": 12345
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Prtry": {
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "BIC"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
+ "required": [],
"example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
"Othr": {
"Id": 123,
"SchmeNm": {
- "Cd": "BIC"
+ "Cd": 123,
+ "Prtry": 123
},
- "Issr": "BIC"
+ "Issr": 123
}
}
},
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
"type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
+ "Id": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -89459,1731 +114316,3826 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 256,
- "example": 256
+ "maxLength": 140,
+ "example": 12345
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Prtry": {
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
- {
- "required": [
- "Prtry"
- ]
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
- ],
+ },
"example": {
- "Cd": "CCPT"
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "Rsn": {
- "description": "Reason\nSpecifies the reason for the status report.",
- "title": "StatusReason6Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nReason for the status, as published in an external reason code list.\n",
- "title": "ExternalStatusReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
]
}
+ },
+ "required": [
+ "FinInstnId"
],
"example": {
- "Cd": "AGNT"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
},
- "AddtlInf": {
- "description": "AdditionalInformation\nAdditional information about the status report.",
- "title": "Max105Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 105,
- "example": 12345
+ {
+ "description": "Agent\nFinancial institution servicing an account for a party.\n"
}
- },
- "example": {
- "Orgtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "SubDepartment",
- "StrtNm": "StreetName",
- "BldgNb": "BuildingNumber",
- "PstCd": "PostCode",
- "TwnNm": "TownName",
- "CtrySubDvsn": "CountrySubDivision",
- "Ctry": "Country"
+ ]
+ }
+ },
+ "required": [
+ "Pty"
+ ],
+ "example": {
+ "Pty": {
+ "Id": {
+ "OrgId": {
+ "AnyBIC": {
+ "BICFI": "BICFI"
}
- },
- "Rsn": {
- "Cd": "AGNT"
- },
- "AddtlInf": "AdditionalInformation"
- }
- },
- "AccptncDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "AcctSvcrRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "ExctnConf": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- },
- "SplmtryData": {
- "title": "SupplementaryData1",
- "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n",
- "type": "object",
- "properties": {
- "PlcAndNm": {
- "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n",
- "title": "Max350Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 350,
- "example": 350
- },
- "Envlp": {
- "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
- "title": "SupplementaryDataEnvelope1",
- "type": "object"
}
},
- "required": [
- "Envlp"
- ],
- "example": {
- "PlcAndNm": "Additional information",
- "Envlp": {
- "Cd": "CH03",
- "Prtry": "Additional information"
- }
+ "CtryOfRes": "FI"
+ },
+ "Acct": {
+ "Id": {
+ "IBAN": "FI2112345600000785"
}
- }
- },
- "example": {
- "StsId": 12345,
- "OrgnlInstrId": 12345,
- "OrgnlEndToEndId": 12345,
- "OrgnlTxId": 12345,
- "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
- "TxSts": "RJCT",
- "StsRsnInf": {
- "Rsn": "RSN",
- "AddtlInf": "ADDITIONAL"
},
- "AccptncDtTm": "2020-01-01T00:00:00Z",
- "AcctSvcrRef": "ACCTSVCRREF",
- "ClrSysRef": "CLRSYSREF",
- "ExctnConf": "1234567890ABCDEF",
- "SplmtryData": {
- "PlcAndNm": "PLACE",
- "Envlp": "ENVELOPE"
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
}
}
},
- "PaymentTypeInformation28": {
- "title": "PaymentTypeInformation28",
- "description": "Provides further details of the type of payment.\n",
+ "IdentificationVerificationIndicator": {
+ "title": "IdentificationVerificationIndicator",
+ "type": "boolean",
+ "example": true,
+ "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n"
+ },
+ "Instruction4Code": {
+ "title": "Instruction4Code",
+ "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n",
+ "type": "string",
+ "enum": [
+ "PHOA",
+ "TELA"
+ ],
+ "example": "PHOA"
+ },
+ "InstructionForCreditorAgent3": {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
"type": "object",
"properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
"type": "string",
"minLength": 1,
"maxLength": 4,
"example": 1234
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
{
- "required": [
- "Prtry"
- ]
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
}
- ],
- "example": {
- "Cd": "SEPA"
- }
+ ]
},
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
+ "maxLength": 140,
"example": 12345
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
}
- },
- "oneOf": [
+ ]
+ }
+ },
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ "InstructionForNextAgent1": {
+ "title": "InstructionForNextAgent1",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Instruction4Code",
+ "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n",
+ "type": "string",
+ "enum": [
+ "PHOA",
+ "TELA"
+ ],
+ "example": "PHOA"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
+ ]
},
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "maxLength": 140,
+ "example": 12345
},
{
- "required": [
- "Prtry"
- ]
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n"
}
- ],
- "example": {
- "Cd": "CASH"
- }
+ ]
}
},
"example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
}
},
- "PercentageRate": {
- "title": "PercentageRate",
+ "LEIIdentifier": {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "PersonIdentification13": {
- "title": "PersonIdentification13",
- "description": "Unique and unambiguous way to identify a person.\n",
+ "LocalInstrument2Choice": {
+ "title": "LocalInstrument2Choice",
"type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
"properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
}
},
"required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ "Cd"
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
+ {
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
+ "Prtry"
+ ]
}
- },
+ ],
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
+ "Cd": "CH03"
}
},
- "PersonIdentification18": {
- "title": "PersonIdentification18",
- "description": "Unique and unambiguous way to identify a person.\n",
+ "Max105Text": {
+ "title": "Max105Text",
+ "description": "Specifies a character string with a maximum length of 105 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 105,
+ "example": 12345
+ },
+ "Max10Text": {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ "Max128Text": {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ "Max140Text": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Max15NumericText": {
+ "title": "Max15NumericText",
+ "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
+ "type": "string",
+ "pattern": "^[0-9]{1,15}$",
+ "example": 123456789012345
+ },
+ "Max16Text": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Max2048Text": {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ "Max256Text": {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ "Max34Text": {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ "Max350Text": {
+ "title": "Max350Text",
+ "description": "Specifies a character string with a maximum length of 350 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 350,
+ "example": 350
+ },
+ "Max35Text": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Max4Text": {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ "Max70Text": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "NamePrefix2Code": {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ "Number": {
+ "title": "Number",
+ "type": "string",
+ "pattern": "^[\\d\\-\\.\\,]{1,18}$",
+ "example": 256
+ },
+ "OrganisationIdentification29": {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
"type": "object",
"properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
},
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
"Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
"type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "CCPT"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
"Othr": {
"Id": 123,
"SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
}
}
},
- "PersonIdentificationSchemeName1Choice": {
- "title": "PersonIdentificationSchemeName1Choice",
- "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "OrganisationIdentification39": {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "PhoneNumber": {
- "title": "PhoneNumber",
- "type": "string",
- "description": "Double check this regex.\n",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "PostalAddress24": {
- "title": "PostalAddress24",
- "type": "object",
- "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
- "example": "ADDR"
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
"type": "object",
+ "description": "Information related to an identification of an organisation.\n",
"properties": {
"Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
},
"SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
}
},
"example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
}
},
- "PostalAddress27": {
- "title": "PostalAddress27",
+ "OrganisationIdentificationSchemeName1Choice": {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
"type": "object",
- "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ "OtherContact1": {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
"type": "string",
- "example": "ADDR"
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ "PacsError_FIToFIPaymentStatusReportV15": {
+ "title": "PacsError_FIToFIPaymentStatusReportV15",
+ "type": "object",
+ "description": "This message is sent by an account servicing institution to an account owner. It is used to inform the account owner about the status of a payment initiation.\n",
+ "properties": {
+ "GrpHdr": {
+ "allOf": [
+ {
+ "title": "GroupHeader120",
+ "description": "Set of characteristics shared by all individual transactions included in the message.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MessageIdentification\nDefinition: Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message.\nUsage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "CreationDateTime\nDate and time at which the message was created.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "TxInfAndSts": {
+ "allOf": [
+ {
+ "title": "PaymentTransaction163",
+ "description": "Provides further details on the original transactions, to which the status report message refers.\n",
+ "type": "object",
+ "properties": {
+ "StsId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n"
+ }
+ ]
+ },
+ "OrgnlInstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n"
+ }
+ ]
+ },
+ "OrgnlEndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n"
+ }
+ ]
+ },
+ "OrgnlTxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n"
+ }
+ ]
+ },
+ "OrgnlUETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n"
+ }
+ ]
+ },
+ "TxSts": {
+ "allOf": [
+ {
+ "title": "ExternalPaymentTransactionStatus1Code",
+ "description": "Specifies the external payment transaction status code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Specifies the status of the transaction.\n"
+ }
+ ]
+ },
+ "StsRsnInf": {
+ "allOf": [
+ {
+ "title": "StatusReasonInformation14",
+ "description": "Unsure on description.\n",
+ "type": "object",
+ "properties": {
+ "Orgtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Originator\nParty that issues the status.\n"
+ }
+ ]
+ },
+ "Rsn": {
+ "allOf": [
+ {
+ "title": "StatusReason6Choice",
+ "description": "Specifies the reason for the status.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalStatusReason1Code",
+ "description": "Specifies the external status reason code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nReason for the status, as published in an external reason code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nReason for the status, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "AGNT"
+ }
+ },
+ {
+ "description": "Reason\nSpecifies the reason for the status report.\n"
+ }
+ ]
+ },
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max105Text",
+ "description": "Specifies a character string with a maximum length of 105 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 105,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\nAdditional information about the status report.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Orgtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "SubDepartment",
+ "StrtNm": "StreetName",
+ "BldgNb": "BuildingNumber",
+ "PstCd": "PostCode",
+ "TwnNm": "TownName",
+ "CtrySubDvsn": "CountrySubDivision",
+ "Ctry": "Country"
+ }
+ },
+ "Rsn": {
+ "Cd": "AGNT"
+ },
+ "AddtlInf": "AdditionalInformation"
+ }
+ },
+ {
+ "description": "Information concerning the reason for the status.\n"
+ }
+ ]
+ },
+ "AccptncDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Date and time at which the status was accepted.\n"
+ }
+ ]
+ },
+ "AcctSvcrRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n"
+ }
+ ]
+ },
+ "ExctnConf": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n"
+ }
+ ]
+ },
+ "SplmtryData": {
+ "allOf": [
+ {
+ "title": "SupplementaryData1",
+ "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n",
+ "type": "object",
+ "properties": {
+ "PlcAndNm": {
+ "allOf": [
+ {
+ "title": "Max350Text",
+ "description": "Specifies a character string with a maximum length of 350 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 350,
+ "example": 350
+ },
+ {
+ "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n"
+ }
+ ]
+ },
+ "Envlp": {
+ "allOf": [
+ {
+ "title": "SupplementaryDataEnvelope1",
+ "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
+ "type": "object"
+ },
+ {
+ "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Envlp"
+ ],
+ "example": {
+ "PlcAndNm": "Additional information",
+ "Envlp": {
+ "Cd": "CH03",
+ "Prtry": "Additional information"
+ }
+ }
+ },
+ {
+ "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "StsId": 12345,
+ "OrgnlInstrId": 12345,
+ "OrgnlEndToEndId": 12345,
+ "OrgnlTxId": 12345,
+ "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
+ "TxSts": "RJCT",
+ "StsRsnInf": {
+ "Rsn": "RSN",
+ "AddtlInf": "ADDITIONAL"
+ },
+ "AccptncDtTm": "2020-01-01T00:00:00Z",
+ "AcctSvcrRef": "ACCTSVCRREF",
+ "ClrSysRef": "CLRSYSREF",
+ "ExctnConf": "1234567890ABCDEF",
+ "SplmtryData": {
+ "PlcAndNm": "PLACE",
+ "Envlp": "ENVELOPE"
+ }
+ }
+ },
+ {
+ "description": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "MsgId",
+ "CreDtTm"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "TxInfAndSts": {
+ "StsId": 12345,
+ "OrgnlInstrId": 12345,
+ "OrgnlEndToEndId": 12345,
+ "OrgnlTxId": 12345,
+ "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
+ "TxSts": "RJCT",
+ "StsRsnInf": {
+ "Rsn": "RSN",
+ "AddtlInf": "ADDITIONAL"
+ },
+ "AccptncDtTm": "2020-01-01T00:00:00Z",
+ "AcctSvcrRef": "ACCTSVCRREF",
+ "ClrSysRef": "CLRSYSREF",
+ "ExctnConf": "1234567890ABCDEF",
+ "SplmtryData": {
+ "PlcAndNm": "PLACE",
+ "Envlp": "ENVELOPE"
+ }
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "PreferredContactMethod1Code": {
- "title": "PreferredContactMethod1Code",
- "description": "Preferred method used to reach the individual contact within an organisation.\n",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- },
- "PreferredContactMethod2Code": {
- "title": "PreferredContactMethod2Code",
- "description": "Preferred method used to reach the individual contact within an organisation.\n",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- },
- "Priority2Code": {
- "title": "Priority2Code",
- "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.\n",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ProxyAccountIdentification1": {
- "title": "ProxyAccountIdentification1",
- "description": "Information related to a proxy identification of the account.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Set of characteristics shared by all individual transactions included in the message.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- },
- "ProxyAccountType1Choice": {
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "description": "ProxyAccountType1Choice\n\nSpecifies the scheme used for the identification of an account alias.\n",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Purpose2Choice": {
- "title": "Purpose2Choice",
- "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "RegulatoryAuthority2": {
- "title": "RegulatoryAuthority2",
- "description": "Information about an entity requiring the regulatory reporting information.\n",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "example": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- }
- },
- "RegulatoryReporting3": {
- "title": "RegulatoryReporting3",
- "description": "Information needed due to regulatory and/or statutory requirements.\n",
- "type": "object",
- "properties": {
- "DbtCdtRptgInd": {
- "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "title": "RegulatoryReportingType1Code",
- "type": "string",
- "enum": [
- "CRED",
- "DEBT",
- "BOTH"
- ],
- "example": "BOTH"
- },
- "Authrty": {
- "description": "Authority\n\nEntity requiring the regulatory reporting information.\n",
- "title": "RegulatoryAuthority2",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "example": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- }
},
- "Dtls": {
- "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "anyOf": [
+ "TxInfAndSts": {
+ "allOf": [
{
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "title": "PaymentTransaction163",
+ "description": "Provides further details on the original transactions, to which the status report message refers.\n",
"type": "object",
"properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "StsId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n"
+ }
+ ]
},
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "OrgnlInstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n"
+ }
+ ]
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "OrgnlEndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n"
+ }
+ ]
},
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
+ "OrgnlTxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n"
+ }
+ ]
+ },
+ "OrgnlUETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n"
+ }
+ ]
+ },
+ "TxSts": {
+ "allOf": [
+ {
+ "title": "ExternalPaymentTransactionStatus1Code",
+ "description": "Specifies the external payment transaction status code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Specifies the status of the transaction.\n"
+ }
+ ]
},
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "StsRsnInf": {
+ "allOf": [
+ {
+ "title": "StatusReasonInformation14",
+ "description": "Unsure on description.\n",
+ "type": "object",
+ "properties": {
+ "Orgtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Originator\nParty that issues the status.\n"
+ }
+ ]
+ },
+ "Rsn": {
+ "allOf": [
+ {
+ "title": "StatusReason6Choice",
+ "description": "Specifies the reason for the status.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalStatusReason1Code",
+ "description": "Specifies the external status reason code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nReason for the status, as published in an external reason code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nReason for the status, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "AGNT"
+ }
+ },
+ {
+ "description": "Reason\nSpecifies the reason for the status report.\n"
+ }
+ ]
+ },
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max105Text",
+ "description": "Specifies a character string with a maximum length of 105 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 105,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\nAdditional information about the status report.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Orgtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "SubDepartment",
+ "StrtNm": "StreetName",
+ "BldgNb": "BuildingNumber",
+ "PstCd": "PostCode",
+ "TwnNm": "TownName",
+ "CtrySubDvsn": "CountrySubDivision",
+ "Ctry": "Country"
+ }
+ },
+ "Rsn": {
+ "Cd": "AGNT"
+ },
+ "AddtlInf": "AdditionalInformation"
+ }
+ },
+ {
+ "description": "Information concerning the reason for the status.\n"
+ }
+ ]
+ },
+ "AccptncDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
+ {
+ "description": "Date and time at which the status was accepted.\n"
+ }
+ ]
+ },
+ "AcctSvcrRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
},
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
+ "ClrSysRef": {
+ "allOf": [
{
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
@@ -91193,814 +118145,1841 @@
"example": 1.234567890123457e+34
},
{
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n"
+ }
+ ]
+ },
+ "ExctnConf": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n"
+ }
+ ]
+ },
+ "SplmtryData": {
+ "allOf": [
+ {
+ "title": "SupplementaryData1",
+ "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n",
+ "type": "object",
+ "properties": {
+ "PlcAndNm": {
+ "allOf": [
+ {
+ "title": "Max350Text",
+ "description": "Specifies a character string with a maximum length of 350 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 350,
+ "example": 350
+ },
+ {
+ "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n"
+ }
+ ]
+ },
+ "Envlp": {
+ "allOf": [
+ {
+ "title": "SupplementaryDataEnvelope1",
+ "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
+ "type": "object"
+ },
+ {
+ "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n"
+ }
+ ]
+ }
},
- "type": "array"
+ "required": [
+ "Envlp"
+ ],
+ "example": {
+ "PlcAndNm": "Additional information",
+ "Envlp": {
+ "Cd": "CH03",
+ "Prtry": "Additional information"
+ }
+ }
+ },
+ {
+ "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n"
}
]
}
},
"example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ "StsId": 12345,
+ "OrgnlInstrId": 12345,
+ "OrgnlEndToEndId": 12345,
+ "OrgnlTxId": 12345,
+ "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
+ "TxSts": "RJCT",
+ "StsRsnInf": {
+ "Rsn": "RSN",
+ "AddtlInf": "ADDITIONAL"
},
- "Inf": 12345
+ "AccptncDtTm": "2020-01-01T00:00:00Z",
+ "AcctSvcrRef": "ACCTSVCRREF",
+ "ClrSysRef": "CLRSYSREF",
+ "ExctnConf": "1234567890ABCDEF",
+ "SplmtryData": {
+ "PlcAndNm": "PLACE",
+ "Envlp": "ENVELOPE"
+ }
}
},
{
- "items": {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
- ]
- }
+ "description": "Information concerning the original transactions, to which the status report message refers.\n"
+ }
+ ]
+ },
+ "SplmtryData": {
+ "allOf": [
+ {
+ "title": "SupplementaryData1",
+ "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n",
+ "type": "object",
+ "properties": {
+ "PlcAndNm": {
+ "allOf": [
+ {
+ "title": "Max350Text",
+ "description": "Specifies a character string with a maximum length of 350 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 350,
+ "example": 350
+ },
+ {
+ "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n"
+ }
+ ]
},
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
+ "Envlp": {
+ "allOf": [
+ {
+ "title": "SupplementaryDataEnvelope1",
+ "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
+ "type": "object"
+ },
+ {
+ "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n"
+ }
+ ]
}
},
- "type": "array"
+ "required": [
+ "Envlp"
+ ],
+ "example": {
+ "PlcAndNm": "Additional information",
+ "Envlp": {
+ "Cd": "CH03",
+ "Prtry": "Additional information"
+ }
+ }
+ },
+ {
+ "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n"
}
]
}
},
- "example": {
- "DbtCdtRptgInd": "CRED",
- "Authrty": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- },
- "Dtls": {
- "Cd": "A1",
- "Inf": "Mandatory regulatory information"
- }
- }
- },
- "RegulatoryReportingType1Code": {
- "title": "RegulatoryReportingType1Code",
- "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.\n",
- "type": "string",
- "enum": [
- "CRED",
- "DEBT",
- "BOTH"
+ "required": [
+ "GrpHdr"
],
- "example": "BOTH"
- },
- "ServiceLevel8Choice": {
- "title": "ServiceLevel8Choice",
- "description": "Details about a service level.\n",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "example": {
+ "GrpHdr": {
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "SttlmInf": {
+ "SttlmMtd": "INDA",
+ "SttlmDt": "2020-01-01"
+ },
+ "InstgAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "InstdAgt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "TxInfAndSts": {
+ "OrgnlInstrId": 12345,
+ "OrgnlEndToEndId": 12345,
+ "TxSts": "RJCT",
+ "StsRsnInf": {
+ "Rsn": "RSN",
+ "AddtlInf": "ADDITIONAL"
+ }
},
- {
- "required": [
- "Prtry"
- ]
+ "SplmtryData": {
+ "PlcAndNm": "PLACE",
+ "Envlp": "ENVELOPE"
}
- ],
- "example": {
- "Cd": "SEPA"
}
},
- "SettlementInstruction15": {
- "title": "SettlementInstruction15",
- "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
+ "PacsStatus_FIToFIPaymentStatusReportV15": {
+ "title": "PacsStatus_FIToFIPaymentStatusReportV15",
+ "description": "The PacsStatus message is sent by a financial institution to another financial institution as a response to the FIToFIPaymentStatusReport message. The message provides information on the status of a payment instruction and its underlying individual transactions.",
"type": "object",
"properties": {
- "SttlmMtd": {
- "description": "SettlementMethod\nMethod used to settle the (batch of) payment instructions.\n",
- "title": "SettlementMethod1Code",
- "type": "string",
- "enum": [
- "INDA",
- "INGA",
- "COVE",
- "CLRG"
- ],
- "example": "CLRG"
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
+ "GrpHdr": {
+ "allOf": [
+ {
+ "title": "GroupHeader120",
+ "description": "Set of characteristics shared by all individual transactions included in the message.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MessageIdentification\nDefinition: Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message.\nUsage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "CreationDateTime\nDate and time at which the message was created.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "TxInfAndSts": {
+ "allOf": [
+ {
+ "title": "PaymentTransaction163",
+ "description": "Provides further details on the original transactions, to which the status report message refers.\n",
+ "type": "object",
+ "properties": {
+ "StsId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n"
+ }
+ ]
+ },
+ "OrgnlInstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n"
+ }
+ ]
+ },
+ "OrgnlEndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n"
+ }
+ ]
+ },
+ "OrgnlTxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n"
+ }
+ ]
+ },
+ "OrgnlUETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n"
+ }
+ ]
+ },
+ "TxSts": {
+ "allOf": [
+ {
+ "title": "ExternalPaymentTransactionStatus1Code",
+ "description": "Specifies the external payment transaction status code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Specifies the status of the transaction.\n"
+ }
+ ]
+ },
+ "StsRsnInf": {
+ "allOf": [
+ {
+ "title": "StatusReasonInformation14",
+ "description": "Unsure on description.\n",
+ "type": "object",
+ "properties": {
+ "Orgtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Originator\nParty that issues the status.\n"
+ }
+ ]
+ },
+ "Rsn": {
+ "allOf": [
+ {
+ "title": "StatusReason6Choice",
+ "description": "Specifies the reason for the status.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalStatusReason1Code",
+ "description": "Specifies the external status reason code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nReason for the status, as published in an external reason code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nReason for the status, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "AGNT"
+ }
+ },
+ {
+ "description": "Reason\nSpecifies the reason for the status report.\n"
+ }
+ ]
+ },
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max105Text",
+ "description": "Specifies a character string with a maximum length of 105 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 105,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\nAdditional information about the status report.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Orgtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "SubDepartment",
+ "StrtNm": "StreetName",
+ "BldgNb": "BuildingNumber",
+ "PstCd": "PostCode",
+ "TwnNm": "TownName",
+ "CtrySubDvsn": "CountrySubDivision",
+ "Ctry": "Country"
+ }
+ },
+ "Rsn": {
+ "Cd": "AGNT"
+ },
+ "AddtlInf": "AdditionalInformation"
+ }
+ },
+ {
+ "description": "Information concerning the reason for the status.\n"
+ }
+ ]
+ },
+ "AccptncDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Date and time at which the status was accepted.\n"
+ }
+ ]
+ },
+ "AcctSvcrRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n"
+ }
+ ]
+ },
+ "ExctnConf": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n"
+ }
+ ]
+ },
+ "SplmtryData": {
+ "allOf": [
+ {
+ "title": "SupplementaryData1",
+ "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n",
+ "type": "object",
+ "properties": {
+ "PlcAndNm": {
+ "allOf": [
+ {
+ "title": "Max350Text",
+ "description": "Specifies a character string with a maximum length of 350 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 350,
+ "example": 350
+ },
+ {
+ "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n"
+ }
+ ]
+ },
+ "Envlp": {
+ "allOf": [
+ {
+ "title": "SupplementaryDataEnvelope1",
+ "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
+ "type": "object"
+ },
+ {
+ "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Envlp"
+ ],
+ "example": {
+ "PlcAndNm": "Additional information",
+ "Envlp": {
+ "Cd": "CH03",
+ "Prtry": "Additional information"
+ }
+ }
+ },
+ {
+ "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "StsId": 12345,
+ "OrgnlInstrId": 12345,
+ "OrgnlEndToEndId": 12345,
+ "OrgnlTxId": 12345,
+ "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
+ "TxSts": "RJCT",
+ "StsRsnInf": {
+ "Rsn": "RSN",
+ "AddtlInf": "ADDITIONAL"
+ },
+ "AccptncDtTm": "2020-01-01T00:00:00Z",
+ "AcctSvcrRef": "ACCTSVCRREF",
+ "ClrSysRef": "CLRSYSREF",
+ "ExctnConf": "1234567890ABCDEF",
+ "SplmtryData": {
+ "PlcAndNm": "PLACE",
+ "Envlp": "ENVELOPE"
+ }
+ }
+ },
+ {
+ "description": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n"
+ }
]
}
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
+ "required": [
+ "MsgId",
+ "CreDtTm"
],
"example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "TxInfAndSts": {
+ "StsId": 12345,
+ "OrgnlInstrId": 12345,
+ "OrgnlEndToEndId": 12345,
+ "OrgnlTxId": 12345,
+ "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
+ "TxSts": "RJCT",
+ "StsRsnInf": {
+ "Rsn": "RSN",
+ "AddtlInf": "ADDITIONAL"
+ },
+ "AccptncDtTm": "2020-01-01T00:00:00Z",
+ "AcctSvcrRef": "ACCTSVCRREF",
+ "ClrSysRef": "CLRSYSREF",
+ "ExctnConf": "1234567890ABCDEF",
+ "SplmtryData": {
+ "PlcAndNm": "PLACE",
+ "Envlp": "ENVELOPE"
+ }
}
- ],
- "example": {
- "Cd": "CASH"
}
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
},
- "CtgyPurp": {
- "Cd": "CASH"
+ {
+ "description": "Set of characteristics shared by all individual transactions included in the message.\n"
}
- }
+ ]
}
},
"required": [
- "SttlmMtd"
+ "GrpHdr"
],
"example": {
- "SttlmMtd": "INDA",
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CH03"
- },
- "CtgyPurp": {
- "Cd": "SUPP"
- },
- "Cdtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "AdrLine": "Address",
- "Ctry": "CH"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN",
- "Issr": "BIC"
- }
- }
- }
+ "GrpHdr": {
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "TxInfAndSts": {
+ "StsId": 12345,
+ "OrgnlInstrId": 12345,
+ "OrgnlEndToEndId": 12345,
+ "OrgnlTxId": 12345,
+ "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
+ "TxSts": "RJCT",
+ "StsRsnInf": {
+ "Rsn": "RSN",
+ "AddtlInf": "ADDITIONAL"
},
- "CtryOfRes": "CH",
- "CtctDtls": {
- "Nm": "Name",
- "PhneNb": 123,
- "EmailAdr": null
+ "AccptncDtTm": "2020-01-01T00:00:00Z",
+ "AcctSvcrRef": "ACCTSVCRREF",
+ "ClrSysRef": "CLRSYSREF",
+ "ExctnConf": "1234567890ABCDEF",
+ "SplmtryData": {
+ "PlcAndNm": "PLACE",
+ "Envlp": "ENVELOPE"
}
}
}
}
},
- "SettlementMethod1Code": {
- "title": "SettlementMethod1Code",
- "description": "Specifies the method used to settle the credit transfer instruction.\n",
- "type": "string",
- "enum": [
- "INDA",
- "INGA",
- "COVE",
- "CLRG"
- ],
- "example": "CLRG"
- },
- "StatusReason6Choice": {
- "title": "StatusReason6Choice",
- "description": "Unsure on description.\n",
+ "Party38Choice": {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nReason for the status, as published in an external reason code list.\n",
- "title": "ExternalStatusReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "AGNT"
- }
- },
- "StatusReasonInformation14": {
- "title": "StatusReasonInformation14",
- "description": "Unsure on description.\n",
- "type": "object",
- "properties": {
- "Orgtr": {
- "description": "Originator\nParty that issues the status.",
- "title": "PartyIdentification272",
- "type": "object",
"properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
"type": "object",
"properties": {
"AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
},
"LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
"type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "BIC"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
"example": {
@@ -92015,3416 +119994,3519 @@
}
}
},
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
"type": "object",
"properties": {
"DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
},
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
},
"Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ "Party40Choice": {
+ "title": "Party40Choice",
+ "description": "Identification of a person, an organisation or a financial institution.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 256,
- "example": 256
+ "maxLength": 140,
+ "example": 12345
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 16,
+ "example": 1234567890123456
},
- "Prtry": {
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
+ "OrgId"
]
},
{
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
+ "PrvtId"
]
}
],
"example": {
- "Cd": "CCPT"
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ ]
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
},
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
}
},
"required": [
- "ChanlTp"
+ "Id"
],
"example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
}
},
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ {
+ "description": "Party\nIdentification of a person or an organisation.\n"
}
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "Rsn": {
- "description": "Reason\nSpecifies the reason for the status report.",
- "title": "StatusReason6Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nReason for the status, as published in an external reason code list.\n",
- "title": "ExternalStatusReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
- ],
- "example": {
- "Cd": "AGNT"
- }
- },
- "AddtlInf": {
- "description": "AdditionalInformation\nAdditional information about the status report.",
- "title": "Max105Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 105,
- "example": 12345
- }
- },
- "example": {
- "Orgtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "SubDepartment",
- "StrtNm": "StreetName",
- "BldgNb": "BuildingNumber",
- "PstCd": "PostCode",
- "TwnNm": "TownName",
- "CtrySubDvsn": "CountrySubDivision",
- "Ctry": "Country"
- }
- },
- "Rsn": {
- "Cd": "AGNT"
- },
- "AddtlInf": "AdditionalInformation"
- }
- },
- "StructuredRegulatoryReporting3": {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
},
"required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
+ "Pty"
]
- }
- },
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- },
- "SupplementaryData1": {
- "title": "SupplementaryData1",
- "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n",
- "type": "object",
- "properties": {
- "PlcAndNm": {
- "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n",
- "title": "Max350Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 350,
- "example": 350
- },
- "Envlp": {
- "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
- "title": "SupplementaryDataEnvelope1",
- "type": "object"
- }
- },
- "required": [
- "Envlp"
- ],
- "example": {
- "PlcAndNm": "Additional information",
- "Envlp": {
- "Cd": "CH03",
- "Prtry": "Additional information"
- }
- }
- },
- "SupplementaryDataEnvelope1": {
- "title": "SupplementaryDataEnvelope1",
- "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
- "type": "object"
- },
- "TaxAmount3": {
- "title": "TaxAmount3",
- "description": "Information on the amount of the tax record.\n",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
},
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
+ {
"properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
}
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
+ ]
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "TaxAuthorisation1": {
- "title": "TaxAuthorisation1",
- "description": "Details of an authorised tax paying party.\n",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- },
- "TaxData1": {
- "title": "TaxData1",
- "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n",
- "type": "object",
- "properties": {
- "Cdtr": {
- "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n",
- "title": "TaxParty1",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT"
- }
- },
- "Dbtr": {
- "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
},
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ {
+ "description": "Agent\nIdentification of a financial institution.\n"
}
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
+ ]
}
},
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "UltmtDbtr": {
- "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
+ "required": [
+ "Agt"
+ ]
+ }
+ ],
+ "example": {
+ "Pty": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "Ctry": "US",
+ "AdrLine": [
+ "Line1",
+ "Line2"
+ ]
},
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
}
}
},
- "AdmstnZone": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RefNb": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Mtd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TtlTaxblBaseAmt": {
- "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BUKBGB22"
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlTaxAmt": {
- "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "BrnchId": {
+ "Id": 12345,
+ "Nm": "Oxford Street Branch",
+ "PstlAdr": {
+ "Ctry": "GB",
+ "AdrLine": [
+ "1 Oxford Street",
+ "London",
+ "UK"
+ ]
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
}
- },
- "Dt": {
- "description": "Date\n\nDate by which tax is due.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "SeqNb": {
- "description": "SequenceNumber\n\nSequential number of the tax report\n",
- "title": "Number",
- "type": "string",
- "pattern": "^[\\d\\-\\.\\,]{1,18}$",
- "example": 256
- },
- "Rcrd": {
- "description": "Record\n\nDetails of the tax record.\n",
- "anyOf": [
- {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
+ }
+ }
+ },
+ "Party52Choice": {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
"type": "object",
"properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
},
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
},
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
+ "Othr": {
+ "allOf": [
{
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
+ "title": "GenericOrganisationIdentification3",
"type": "object",
+ "description": "Information related to an identification of an organisation.\n",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
"type": "object",
"properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
}
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
],
- "example": "HLF1"
+ "example": {
+ "Cd": "BIC"
+ }
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
}
- }
+ ]
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
+ "Id"
],
"example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ "Issr": "BIC"
}
},
{
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- "type": "array"
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
}
]
}
},
"example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
},
- "Inf": 12345
+ "Issr": "BIC"
}
}
},
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
}
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
- },
- {
- "items": {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
},
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
}
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
}
- }
+ ]
},
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
}
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
}
},
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
"type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
}
},
"required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "Cd"
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
],
"example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ "Cd": "CCPT"
}
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
}
- }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
},
- "type": "array"
+ "Issr": "BIC"
}
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
},
- "Inf": 12345
- }
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
}
},
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
}
},
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
}
- },
- "type": "array"
+ ]
}
+ },
+ "required": [
+ "PrvtId"
]
}
- },
+ ],
"example": {
- "Cdtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "Dbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "UltmtDbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "AdmstnZone": "CH",
- "RefNb": 12345,
- "Mtd": "A",
- "TtlTaxblBaseAmt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "TtlTaxAmt": {
- "Ccy": "CHF",
- "Amt": 100
- },
- "Dt": "2018-01-01",
- "SeqNb": 1,
- "Rcrd": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "TaxParty1": {
- "title": "TaxParty1",
- "description": "Details about the entity involved in the tax paid or to be paid.\n",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "OrgId": {
+ "AnyBIC": "BIC"
},
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
}
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT"
}
},
- "TaxParty2": {
- "title": "TaxParty2",
- "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "PartyIdentification135": {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
+ "Nm": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 140,
"example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "TaxPeriod3": {
- "title": "TaxPeriod3",
- "description": "Period of time details related to the tax payment.\n",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
}
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxRecord3": {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
},
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
"type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
"type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
"example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
{
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
"type": "object",
"properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
}
},
- "required": [
- "FrDt",
- "ToDt"
- ],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
+ "OrgId"
+ ]
},
{
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
- },
- "TaxRecordDetails3": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
}
- },
- "required": [
- "FrDt",
- "ToDt"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
}
- }
+ ]
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ ]
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- "TaxRecordPeriod1Code": {
- "title": "TaxRecordPeriod1Code",
- "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "TermsRequest_FIToFICustomerCreditProposal": {
- "title": "TermsRequest_FIToFICustomerCreditProposal",
- "type": "object",
- "properties": {
- "GrpHdr": {
- "title": "GroupHeader129",
- "description": "Set of characteristics shared by all individual transactions included in the message.\n",
- "type": "object",
- "properties": {
- "MsgId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CreDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "PmtInstrXpryDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
- "type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
- },
- "NbOfTxs": {
- "title": "Max15NumericText",
- "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
- "type": "string",
- "pattern": "^[0-9]{1,15}$",
- "example": 123456789012345
- },
- "SttlmInf": {
- "title": "SettlementInstruction15",
- "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
"type": "object",
"properties": {
- "SttlmMtd": {
- "description": "SettlementMethod\nMethod used to settle the (batch of) payment instructions.\n",
- "title": "SettlementMethod1Code",
- "type": "string",
- "enum": [
- "INDA",
- "INGA",
- "COVE",
- "CLRG"
- ],
- "example": "CLRG"
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
"enum": [
- "HIGH",
- "NORM"
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
"type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
+ "example": "DOCT"
},
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
}
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "LclInstrm": {
- "Cd": "CORE"
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
},
- "CtgyPurp": {
- "Cd": "CASH"
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
}
- }
- }
- },
- "required": [
- "SttlmMtd"
- ],
- "example": {
- "SttlmMtd": "INDA",
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CH03"
- },
- "CtgyPurp": {
- "Cd": "SUPP"
- },
- "Cdtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "AdrLine": "Address",
- "Ctry": "CH"
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
},
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN",
- "Issr": "BIC"
- }
- }
- }
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
},
- "CtryOfRes": "CH",
- "CtctDtls": {
- "Nm": "Name",
- "PhneNb": 123,
- "EmailAdr": null
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
}
- }
- }
- }
- },
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction67",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 2048,
+ "example": 2048
},
- "EndToEndId": {
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -95432,7 +123514,14 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "TxId": {
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -95440,794 +123529,685 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
}
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
+ ]
},
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n\n Set of elements used to further specify the type of transaction.\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
]
}
+ },
+ "required": [
+ "ChanlTp"
],
"example": {
- "Cd": "SEPA"
+ "ChanlTp": "PHON",
+ "Id": 1234567890
}
},
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ "PartyIdentification272": {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
"properties": {
"Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
]
}
- ],
- "example": {
- "Cd": "CH03"
- }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
+ {
"properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
"Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
]
}
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n",
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
],
"example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ "Cd": "ADDR"
}
},
- "InstdAmt": {
- "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "XchgRate": {
- "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n",
- "title": "BaseOneRate",
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 0.7
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "ChrgBr": {
- "description": "ChargeBearer\nSpecifies which party/parties will bear the charges associated with the processing of the payment transaction.\n",
- "title": "ChargeBearerType1Code",
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "enum": [
- "DEBT",
- "CRED",
- "SHAR",
- "SLEV"
- ],
- "example": "DEBT"
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "ChrgsInf": {
- "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction\n",
- "title": "Charges16",
- "type": "object",
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Amt": {
- "description": "Amount\n\n Transaction charges to be paid by the charge bearer.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Agt": {
- "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
"type": "object",
"properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
},
- "MmbId": 123456789
- }
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
},
"LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Information related to an identification of an organisation.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 256,
+ "example": 256
},
- "SchmeNm": {
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
+ "required": [
+ "Id"
],
"example": {
- "Cd": "BIC"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
+ ]
}
},
"example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
"Othr": {
"Id": 123,
"SchmeNm": {
- "Cd": "CHQB"
+ "Cd": "BIC"
},
- "Issr": 123
+ "Issr": "BIC"
}
}
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "format": "date",
+ "example": "2013-03-07"
},
- "Issr": {
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -96235,931 +124215,2179 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "ADDR"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
}
},
"example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Tp": {
- "description": "Type\n\n Defines the type of charges.\n",
- "title": "ChargeType3Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCharge type, in a coded form.\n",
- "title": "ExternalChargeType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n",
- "title": "GenericIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "Issr": "BIC"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
}
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
],
- "example": {
- "Cd": "CASH"
- }
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
}
- },
- "required": [
- "Amt",
- "Agt"
- ],
- "example": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
},
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Tp": {
- "Cd": "SHAR"
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
}
- }
+ ]
},
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
"type": "object",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
"type": "string",
- "example": "ADDR"
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Id": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
+ "required": [
+ "ChanlTp"
+ ],
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "ChanlTp": "PHON",
+ "Id": 1234567890
}
},
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ "PaymentIdentification13": {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
+ "type": "object",
+ "properties": {
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
+ },
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
+ }
+ ]
+ },
+ "UETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "TxId"
+ ],
+ "example": {
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
+ }
+ },
+ "PaymentTransaction163": {
+ "title": "PaymentTransaction163",
+ "description": "Provides further details on the original transactions, to which the status report message refers.\n",
+ "type": "object",
+ "properties": {
+ "StsId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n"
+ }
+ ]
+ },
+ "OrgnlInstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n"
+ }
+ ]
+ },
+ "OrgnlEndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n"
+ }
+ ]
+ },
+ "OrgnlTxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n"
+ }
+ ]
+ },
+ "OrgnlUETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n"
+ }
+ ]
+ },
+ "TxSts": {
+ "allOf": [
+ {
+ "title": "ExternalPaymentTransactionStatus1Code",
+ "description": "Specifies the external payment transaction status code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Specifies the status of the transaction.\n"
+ }
+ ]
+ },
+ "StsRsnInf": {
+ "allOf": [
+ {
+ "title": "StatusReasonInformation14",
+ "description": "Unsure on description.\n",
+ "type": "object",
+ "properties": {
+ "Orgtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "AdrTp": {
+ "title": "AddressType3Choice",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
+ "description": "Choice of formats for the type of address.\n",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "ADDR"
}
},
- "Issr": {
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "Id"
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
+ "OrgId": {
+ "AnyBIC": "BIC"
},
- "Issr": "BIC"
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
}
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
}
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
}
- }
+ ]
},
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
"type": "object",
"properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
},
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
},
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Prtry": {
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Dept": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
{
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
- ]
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
}
},
- "required": [
- "Id"
- ],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
}
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
}
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
},
- "example": {
+ "PrvtId": {
"DtAndPlcOfBirth": {
"Dt": "2018-01-01",
"CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
}
}
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
}
- },
+ }
+ },
+ {
+ "description": "Originator\nParty that issues the status.\n"
+ }
+ ]
+ },
+ "Rsn": {
+ "allOf": [
+ {
+ "title": "StatusReason6Choice",
+ "description": "Specifies the reason for the status.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalStatusReason1Code",
+ "description": "Specifies the external status reason code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nReason for the status, as published in an external reason code list.\n"
+ }
+ ]
+ }
+ },
"required": [
- "OrgId"
+ "Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nReason for the status, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
- "PrvtId"
+ "Prtry"
]
}
],
"example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
+ "Cd": "AGNT"
}
},
- "CtryOfRes": {
- "title": "CountryCode",
+ {
+ "description": "Reason\nSpecifies the reason for the status report.\n"
+ }
+ ]
+ },
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max105Text",
+ "description": "Specifies a character string with a maximum length of 105 characters.\n",
"type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "minLength": 1,
+ "maxLength": 105,
+ "example": 12345
},
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "AdditionalInformation\nAdditional information about the status report.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Orgtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "SubDepartment",
+ "StrtNm": "StreetName",
+ "BldgNb": "BuildingNumber",
+ "PstCd": "PostCode",
+ "TwnNm": "TownName",
+ "CtrySubDvsn": "CountrySubDivision",
+ "Ctry": "Country"
+ }
+ },
+ "Rsn": {
+ "Cd": "AGNT"
+ },
+ "AddtlInf": "AdditionalInformation"
+ }
+ },
+ {
+ "description": "Information concerning the reason for the status.\n"
+ }
+ ]
+ },
+ "AccptncDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Date and time at which the status was accepted.\n"
+ }
+ ]
+ },
+ "AcctSvcrRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n"
+ }
+ ]
+ },
+ "ExctnConf": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n"
+ }
+ ]
+ },
+ "SplmtryData": {
+ "allOf": [
+ {
+ "title": "SupplementaryData1",
+ "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n",
+ "type": "object",
+ "properties": {
+ "PlcAndNm": {
+ "allOf": [
+ {
+ "title": "Max350Text",
+ "description": "Specifies a character string with a maximum length of 350 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 350,
+ "example": 350
+ },
+ {
+ "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n"
+ }
+ ]
+ },
+ "Envlp": {
+ "allOf": [
+ {
+ "title": "SupplementaryDataEnvelope1",
+ "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
+ "type": "object"
+ },
+ {
+ "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Envlp"
+ ],
+ "example": {
+ "PlcAndNm": "Additional information",
+ "Envlp": {
+ "Cd": "CH03",
+ "Prtry": "Additional information"
+ }
+ }
+ },
+ {
+ "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "StsId": 12345,
+ "OrgnlInstrId": 12345,
+ "OrgnlEndToEndId": 12345,
+ "OrgnlTxId": 12345,
+ "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
+ "TxSts": "RJCT",
+ "StsRsnInf": {
+ "Rsn": "RSN",
+ "AddtlInf": "ADDITIONAL"
+ },
+ "AccptncDtTm": "2020-01-01T00:00:00Z",
+ "AcctSvcrRef": "ACCTSVCRREF",
+ "ClrSysRef": "CLRSYSREF",
+ "ExctnConf": "1234567890ABCDEF",
+ "SplmtryData": {
+ "PlcAndNm": "PLACE",
+ "Envlp": "ENVELOPE"
+ }
+ }
+ },
+ "PaymentTypeInformation28": {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
+ "type": "object",
+ "properties": {
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ "maxLength": 4,
+ "example": 1234
},
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
"type": "string",
"minLength": 1,
- "maxLength": 256,
- "example": 256
+ "maxLength": 35,
+ "example": 12345
},
- "EmailPurp": {
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "example": 1234
},
- "Rspnsblty": {
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -97167,625 +126395,861 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
}
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
+ ]
}
},
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
+ },
+ "PercentageRate": {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ "PersonIdentification13": {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
},
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
}
- }
+ ]
},
- "DbtrAcct": {
- "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
"type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
"type": "string",
"minLength": 1,
"maxLength": 4,
"example": 1234
},
- "Prtry": {
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
}
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
+ "Prtry"
]
}
],
"example": {
- "IBAN": "BE71096123456769"
+ "Cd": "CCPT"
}
},
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ "PersonIdentification18": {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "CACC"
+ "Cd": "CCPT"
}
},
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ "PersonIdentificationSchemeName1Choice": {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ "PhoneNumber": {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ "PostalAddress24": {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
"type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "example": "ADDR"
},
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
"type": "object",
+ "description": "Generic scheme identification for a party.\n",
"properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
+ "pattern": "^[a-zA-Z0-9]{4}$",
"example": 1234
},
- "Prtry": {
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
{
- "required": [
- "Prtry"
- ]
+ "description": "SchemeName\nShort textual description of the scheme.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ ]
}
},
"required": [
- "Id"
+ "Id",
+ "Issr"
],
"example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
}
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
},
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
}
- }
- },
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ "PostalAddress27": {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
},
- "CtrySubDvsn": {
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -97793,49 +127257,14 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
+ "SchmeNm": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -97843,102 +127272,269 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
+ ]
}
},
+ "required": [
+ "Id",
+ "Issr"
+ ],
"example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
}
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ "PreferredContactMethod1Code": {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ "PreferredContactMethod2Code": {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ "Priority2Code": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ProxyAccountIdentification1": {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -97946,588 +127542,793 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ "ProxyAccountType1Choice": {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ "Purpose2Choice": {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ "RegulatoryAuthority2": {
+ "title": "RegulatoryAuthority2",
+ "description": "Information about an entity requiring the regulatory reporting information.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ }
+ },
+ "RegulatoryReporting3": {
+ "title": "RegulatoryReporting3",
+ "description": "Information needed due to regulatory and/or statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "DbtCdtRptgInd": {
+ "allOf": [
+ {
+ "title": "RegulatoryReportingType1Code",
+ "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n",
+ "type": "string",
+ "enum": [
+ "CRED",
+ "DEBT",
+ "BOTH"
+ ],
+ "example": "BOTH"
+ },
+ {
+ "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n"
+ }
+ ]
+ },
+ "Authrty": {
+ "allOf": [
+ {
+ "title": "RegulatoryAuthority2",
+ "description": "Information about an entity requiring the regulatory reporting information.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ }
+ },
+ {
+ "description": "Authority\n\nEntity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
+ "anyOf": [
+ {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
}
},
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
"example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
}
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
}
- }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
},
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
+ "Inf": 12345
+ }
+ },
+ {
+ "items": {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
+ {
+ "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.\n"
}
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
+ ]
},
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DbtCdtRptgInd": "CRED",
+ "Authrty": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ },
+ "Dtls": {
+ "Cd": "A1",
+ "Inf": "Mandatory regulatory information"
+ }
+ }
+ },
+ "RegulatoryReportingType1Code": {
+ "title": "RegulatoryReportingType1Code",
+ "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n",
+ "type": "string",
+ "enum": [
+ "CRED",
+ "DEBT",
+ "BOTH"
+ ],
+ "example": "BOTH"
+ },
+ "ServiceLevel8Choice": {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ "SettlementInstruction15": {
+ "title": "SettlementInstruction15",
+ "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
+ "type": "object",
+ "properties": {
+ "SttlmMtd": {
+ "title": "SettlementMethod1Code",
+ "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n",
+ "type": "string",
+ "enum": [
+ "INDA",
+ "INGA",
+ "COVE",
+ "CLRG"
+ ],
+ "example": "CLRG"
+ },
+ "PmtTpInf": {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
+ "type": "object",
+ "properties": {
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 4,
+ "example": 1234
},
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
"type": "string",
"minLength": 1,
- "maxLength": 140,
+ "maxLength": 35,
"example": 12345
},
- "CtrySubDvsn": {
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -98535,49 +128336,59 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
"type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "example": 1234
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -98585,117 +128396,339 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
+ }
+ },
+ "required": [
+ "SttlmMtd"
+ ],
+ "example": {
+ "SttlmMtd": "INDA",
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CH03"
+ },
+ "CtgyPurp": {
+ "Cd": "SUPP"
+ },
+ "Cdtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "AdrLine": "Address",
+ "Ctry": "CH"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN",
+ "Issr": "BIC"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "CH",
+ "CtctDtls": {
+ "Nm": "Name",
+ "PhneNb": 123,
+ "EmailAdr": null
+ }
+ }
+ }
+ }
+ },
+ "SettlementMethod1Code": {
+ "title": "SettlementMethod1Code",
+ "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n",
+ "type": "string",
+ "enum": [
+ "INDA",
+ "INGA",
+ "COVE",
+ "CLRG"
+ ],
+ "example": "CLRG"
+ },
+ "StatusReason6Choice": {
+ "title": "StatusReason6Choice",
+ "description": "Specifies the reason for the status.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalStatusReason1Code",
+ "description": "Specifies the external status reason code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nReason for the status, as published in an external reason code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nReason for the status, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "AGNT"
+ }
+ },
+ "StatusReasonInformation14": {
+ "title": "StatusReasonInformation14",
+ "description": "Unsure on description.\n",
+ "type": "object",
+ "properties": {
+ "Orgtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
"properties": {
"Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
]
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "Id"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
+ "Cd": "ADDR"
}
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
},
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 140,
+ "example": 12345
},
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
"type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
},
- "Nm": {
+ "BldgNm": {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
@@ -98703,126 +128736,593 @@
"maxLength": 140,
"example": 12345
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
}
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
}
- },
- "oneOf": [
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
}
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "example": "DOCT"
},
- "BldgNm": {
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
@@ -98830,71 +129330,113 @@
"maxLength": 140,
"example": 12345
},
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
"type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
},
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
"type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
},
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
"type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
},
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "maxLength": 2048,
+ "example": 2048
},
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 256,
+ "example": 256
},
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "CtrySubDvsn": {
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -98902,1465 +129444,1156 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
"title": "Max70Text",
"description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 70,
"example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
}
},
"example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
}
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Originator\nParty that issues the status.\n"
+ }
+ ]
+ },
+ "Rsn": {
+ "allOf": [
+ {
+ "title": "StatusReason6Choice",
+ "description": "Specifies the reason for the status.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalStatusReason1Code",
+ "description": "Specifies the external status reason code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nReason for the status, as published in an external reason code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nReason for the status, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "AGNT"
+ }
+ },
+ {
+ "description": "Reason\nSpecifies the reason for the status report.\n"
+ }
+ ]
+ },
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max105Text",
+ "description": "Specifies a character string with a maximum length of 105 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 105,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\nAdditional information about the status report.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Orgtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "SubDepartment",
+ "StrtNm": "StreetName",
+ "BldgNb": "BuildingNumber",
+ "PstCd": "PostCode",
+ "TwnNm": "TownName",
+ "CtrySubDvsn": "CountrySubDivision",
+ "Ctry": "Country"
+ }
+ },
+ "Rsn": {
+ "Cd": "AGNT"
+ },
+ "AddtlInf": "AdditionalInformation"
+ }
+ },
+ "StructuredRegulatoryReporting3": {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ "SupplementaryData1": {
+ "title": "SupplementaryData1",
+ "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n",
+ "type": "object",
+ "properties": {
+ "PlcAndNm": {
+ "allOf": [
+ {
+ "title": "Max350Text",
+ "description": "Specifies a character string with a maximum length of 350 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 350,
+ "example": 350
+ },
+ {
+ "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n"
+ }
+ ]
+ },
+ "Envlp": {
+ "allOf": [
+ {
+ "title": "SupplementaryDataEnvelope1",
+ "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
+ "type": "object"
+ },
+ {
+ "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Envlp"
+ ],
+ "example": {
+ "PlcAndNm": "Additional information",
+ "Envlp": {
+ "Cd": "CH03",
+ "Prtry": "Additional information"
+ }
+ }
+ },
+ "SupplementaryDataEnvelope1": {
+ "title": "SupplementaryDataEnvelope1",
+ "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n",
+ "type": "object"
+ },
+ "TaxAmount3": {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
+ {
+ "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.\n"
}
- }
+ ]
},
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
"type": "object",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "FrToDt": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "FrDt": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "FromDate\nStart date of the range.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "ToDt": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
},
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
}
},
"required": [
- "Id"
+ "FrDt",
+ "ToDt"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
}
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
}
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
}
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
]
},
- {
- "required": [
- "PrvtId"
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
]
}
- ],
+ },
"example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
}
}
},
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
},
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
+ {
+ "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.\n"
}
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
+ ]
},
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
"example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
}
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
}
},
- "CdtrAcct": {
- "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": 1111
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
}
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
+ ]
},
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
}
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
}
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
}
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
}
},
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
}
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ "TaxAuthorisation1": {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ "TaxData1": {
+ "title": "TaxData1",
+ "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n",
+ "type": "object",
+ "properties": {
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "TaxParty1",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ {
+ "description": "TaxIdentification\n\nTax identification number of the creditor.\n"
}
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
+ ]
},
- "InstrForNxtAgt": {
- "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForNextAgent1",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
- "title": "Instruction4Code",
- "type": "string",
- "enum": [
- "PHOA",
- "TELA"
- ],
- "example": "PHOA"
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
}
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone"
- }
+ ]
},
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Prtry": {
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT"
+ }
+ },
+ {
+ "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n"
+ }
+ ]
+ },
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
+ ]
},
- "RgltryRptg": {
- "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n",
- "title": "RegulatoryReporting3",
- "type": "object",
- "properties": {
- "DbtCdtRptgInd": {
- "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "title": "RegulatoryReportingType1Code",
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "enum": [
- "CRED",
- "DEBT",
- "BOTH"
- ],
- "example": "BOTH"
- },
- "Authrty": {
- "description": "Authority\n\nEntity requiring the regulatory reporting information.\n",
- "title": "RegulatoryAuthority2",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "example": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- }
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Dtls": {
- "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "anyOf": [
- {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- },
- {
- "items": {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- },
- "type": "array"
- }
- ]
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
}
- },
- "example": {
- "DbtCdtRptgInd": "CRED",
- "Authrty": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Dtls": {
- "Cd": "A1",
- "Inf": "Mandatory regulatory information"
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
}
- }
+ ]
},
- "Tax": {
- "description": "Tax\nProvides details on the tax.\n",
- "title": "TaxData1",
- "type": "object",
- "properties": {
- "Cdtr": {
- "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n",
- "title": "TaxParty1",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT"
- }
- },
- "Dbtr": {
- "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n",
- "title": "TaxParty2",
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
"type": "object",
"properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
+ "Titl": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -100368,66 +130601,115 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Nm": {
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 140,
"example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
}
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
+ ]
}
},
"example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
+ "Titl": "Mr",
+ "Nm": "John Doe"
}
},
- "UltmtDbtr": {
- "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n",
- "title": "TaxParty2",
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
+ },
+ {
+ "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n"
+ }
+ ]
+ },
+ "UltmtDbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
"type": "object",
"properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
+ "Titl": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -100435,40 +130717,234 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Nm": {
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 140,
"example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
}
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
+ ]
}
},
"example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
+ "Titl": "Mr",
+ "Nm": "John Doe"
}
},
- "AdmstnZone": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
+ },
+ {
+ "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n"
+ }
+ ]
+ },
+ "AdmstnZone": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n"
+ }
+ ]
+ },
+ "RefNb": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n"
+ }
+ ]
+ },
+ "Mtd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n"
+ }
+ ]
+ },
+ "TtlTaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlTaxAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
},
- "RefNb": {
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate by which tax is due.\n"
+ }
+ ]
+ },
+ "SeqNb": {
+ "allOf": [
+ {
+ "title": "Number",
+ "type": "string",
+ "pattern": "^[\\d\\-\\.\\,]{1,18}$",
+ "example": 256
+ },
+ {
+ "description": "SequenceNumber\n\nSequential number of the tax report.\n"
+ }
+ ]
+ },
+ "Rcrd": {
+ "description": "Record\n\nDetails of the tax record.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
"title": "Max140Text",
"description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
@@ -100476,7 +130952,14 @@
"maxLength": 140,
"example": 12345
},
- "Mtd": {
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -100484,308 +130967,357 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "TtlTaxblBaseAmt": {
- "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "TtlTaxAmt": {
- "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Dt": {
- "description": "Date\n\nDate by which tax is due.\n",
- "title": "ISODate",
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "SeqNb": {
- "description": "SequenceNumber\n\nSequential number of the tax report\n",
- "title": "Number",
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[\\d\\-\\.\\,]{1,18}$",
- "example": 256
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Rcrd": {
- "description": "Record\n\nDetails of the tax record.\n",
- "anyOf": [
- {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
},
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
},
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
},
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
},
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ {
+ "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.\n"
}
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
+ ]
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
"example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
"pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
"example": 123.45
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "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.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
},
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
+ "Ccy": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyCode",
"type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
"pattern": "^[A-Z]{3,3}$",
"example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
{
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
"type": "object",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
+ "FrToDt": {
+ "allOf": [
+ {
"title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
"type": "object",
"properties": {
"FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
},
"ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
}
},
"required": [
@@ -100793,13 +131325,20 @@
"ToDt"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
"title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
"type": "string",
"enum": [
"MM01",
@@ -100823,99 +131362,155 @@
],
"example": "HLF1"
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
"title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
"type": "string",
"pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
"example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
}
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
"pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
"example": 123.45
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyCode",
"type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
"pattern": "^[A-Z]{3,3}$",
"example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
{
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
"type": "object",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
+ "FrToDt": {
+ "allOf": [
+ {
"title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
"type": "object",
"properties": {
"FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
},
"ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
}
},
"required": [
@@ -100923,13 +131518,20 @@
"ToDt"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
"title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
"type": "string",
"enum": [
"MM01",
@@ -100953,355 +131555,567 @@
],
"example": "HLF1"
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
"title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
"type": "string",
"pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
"example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
}
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
"pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
"example": 123.45
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyCode",
"type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
"pattern": "^[A-Z]{3,3}$",
"example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
},
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
},
- "Inf": 12345
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
}
- }
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ },
+ "type": "array"
}
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
},
- {
- "items": {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
"type": "object",
"properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
+ "FrDt": {
+ "allOf": [
+ {
"title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
"type": "string",
"format": "date",
"example": "2013-03-07"
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
"title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
"type": "string",
"format": "date",
"example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
}
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
+ ]
}
},
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
"example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
}
},
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
"pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
"example": 123.45
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyCode",
"type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
"pattern": "^[A-Z]{3,3}$",
"example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
"pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
"example": 123.45
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyCode",
"type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
"pattern": "^[A-Z]{3,3}$",
"example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
{
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
"type": "object",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
+ "FrToDt": {
+ "allOf": [
+ {
"title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
"type": "object",
"properties": {
"FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
},
"ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
}
},
"required": [
@@ -101309,13 +132123,20 @@
"ToDt"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
"title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
"type": "string",
"enum": [
"MM01",
@@ -101339,99 +132160,155 @@
],
"example": "HLF1"
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
"title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
"type": "string",
"pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
"example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
}
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
"pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
"example": 123.45
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyCode",
"type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
"pattern": "^[A-Z]{3,3}$",
"example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
{
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
"type": "object",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
+ "FrToDt": {
+ "allOf": [
+ {
"title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
"type": "object",
"properties": {
"FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
},
"ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
}
},
"required": [
@@ -101439,13 +132316,20 @@
"ToDt"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
"title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
"type": "string",
"enum": [
"MM01",
@@ -101469,419 +132353,529 @@
],
"example": "HLF1"
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
"title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
"type": "string",
"pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
"example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
}
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
"pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
"example": 123.45
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyCode",
"type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
"pattern": "^[A-Z]{3,3}$",
"example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
}
},
"required": [
- "Amt"
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
},
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
},
- "Inf": 12345
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
}
- }
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ },
+ "type": "array"
}
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
},
- "type": "array"
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
}
- ]
- }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
},
- "example": {
- "Cdtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "Dbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "UltmtDbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "AdmstnZone": "CH",
- "RefNb": 12345,
- "Mtd": "A",
- "TtlTaxblBaseAmt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "TtlTaxAmt": {
- "Ccy": "CHF",
- "Amt": 100
- },
- "Dt": "2018-01-01",
- "SeqNb": 1,
- "Rcrd": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Inf": 12345
- }
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
}
},
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
},
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
}
},
- "oneOf": [
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cdtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "Dbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "UltmtDbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "AdmstnZone": "CH",
+ "RefNb": 12345,
+ "Mtd": "A",
+ "TtlTaxblBaseAmt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "TtlTaxAmt": {
+ "Ccy": "CHF",
+ "Amt": 100
+ },
+ "Dt": "2018-01-01",
+ "SeqNb": 1,
+ "Rcrd": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ "TaxParty1": {
+ "title": "TaxParty1",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the creditor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT"
+ }
+ },
+ "TaxParty2": {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
{
- "required": [
- "IlpV4PrepPacket"
- ]
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
{
- "required": [
- "Sh256Sgntr"
- ]
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
}
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "ChrgBr",
- "Dbtr",
- "DbtrAgt",
- "CdtrAgt",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- },
- "SeqTp": "SEQTP"
- },
- "IntrBkSttlmAmt": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "InstdAmt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ ]
},
- "XchgRate": 123.45,
- "ChrgBr": "SHAR",
- "ChrgsInf": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "FinInstnId": {
- "BICFI": "BICFI"
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
}
- },
- "Tp": {
- "Cd": "SHAR"
- }
- },
- "Dbtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "CODE"
- },
- "InstrForNxtAgt": {
- "Cd": "CODE"
- },
- "Purp": {
- "Cd": "CASH"
- },
- "RgltryRptg": {
- "Dbtr": true,
- "Cdtr": true
- },
- "Tax": "Cdtr"
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm",
- "NbOfTxs",
- "SttlmInf",
- "CdtTrfTxInf"
- ],
- "example": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "SttlmInf": {
- "SttlmMtd": "INDA",
- "SttlmAcct": {
- "Id": {
- "IBAN": 123
+ ]
}
},
- "SttlmAcctOwnr": {
+ "example": {
+ "Titl": "Mr",
"Nm": "John Doe"
- },
- "SttlmAcctSvcr": {
- "BICFI": 123
}
},
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 123,
- "EndToEndId": 123
- },
- "PmtTpInf": {
- "InstrPrty": "NORM"
- },
- "InstdAmt": {
- "Amt": 123,
- "Ccy": "EUR"
- },
- "ChrgBr": "SLEV",
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": 123
- }
- },
- "Cdtr": {
- "Nm": "John Doe"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": 123
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
+ },
+ "TaxPeriod3": {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
}
},
- "RmtInf": {
- "Ustrd": "Test"
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
}
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
}
- }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
}
},
- "required": [
- "GrpHdr"
- ],
"example": {
- "GrpHdr": {
- "MsgId": 123456789,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "CtrlSum": 100,
- "InitgPty": {
- "Nm": "Initiating Party Name",
- "Id": {
- "OrgId": {
- "Othr": [
- {
- "Id": 123456789,
- "SchmeNm": {
- "Cd": "BBA",
- "Prtry": "Party Identification Scheme Name"
- }
- }
- ]
- }
- }
- },
- "FwdgAgt": {
- "FinInstnId": {
- "BICFI": "BBBBBBBB"
- }
- }
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
}
}
},
- "TermsResponse_FIToFICustomerCreditConfirmation": {
- "title": "TermsResponse_FIToFICustomerCreditConfirmation",
+ "TaxRecord3": {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
"type": "object",
"properties": {
- "GrpHdr": {
- "title": "GroupHeader129",
- "description": "Set of characteristics shared by all individual transactions included in the message.\n",
- "type": "object",
- "properties": {
- "MsgId": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -101889,3578 +132883,8552 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "CreDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "PmtInstrXpryDtTm": {
- "title": "ISODateTime",
- "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "format": "datetime",
- "example": "2013-03-07T14:44:30.000Z"
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "NbOfTxs": {
- "title": "Max15NumericText",
- "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
- "pattern": "^[0-9]{1,15}$",
- "example": 123456789012345
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "SttlmInf": {
- "title": "SettlementInstruction15",
- "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
"type": "object",
"properties": {
- "SttlmMtd": {
- "description": "SettlementMethod\nMethod used to settle the (batch of) payment instructions.\n",
- "title": "SettlementMethod1Code",
- "type": "string",
- "enum": [
- "INDA",
- "INGA",
- "COVE",
- "CLRG"
- ],
- "example": "CLRG"
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
},
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
"type": "string",
"enum": [
- "HIGH",
- "NORM"
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
],
- "example": "HIGH"
+ "example": "HLF1"
},
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
"type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
},
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
]
}
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Cd": "SEPA"
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
]
}
+ },
+ "required": [
+ "Amt"
],
"example": {
- "Cd": "CH03"
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
}
},
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
+ "type": "array"
}
- }
+ ]
}
},
- "required": [
- "SttlmMtd"
- ],
"example": {
- "SttlmMtd": "INDA",
- "PmtTpInf": {
- "InstrPrty": "NORM",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CH03"
- },
- "CtgyPurp": {
- "Cd": "SUPP"
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
},
- "Cdtr": {
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "AdrLine": "Address",
- "Ctry": "CH"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN",
- "Issr": "BIC"
- }
- }
- }
- },
- "CtryOfRes": "CH",
- "CtctDtls": {
- "Nm": "Name",
- "PhneNb": 123,
- "EmailAdr": null
- }
- }
+ "Inf": 12345
}
}
},
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction67",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ "TaxRecordDetails3": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
"type": "object",
"properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n\n Set of elements used to further specify the type of transaction.\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
]
}
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
+ "required": [
+ "FrDt",
+ "ToDt"
],
"example": {
- "Cd": "CH03"
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
}
},
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
+ "example": "HLF1"
},
- "CtgyPurp": {
- "Cd": "CASH"
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
}
- }
+ ]
},
- "IntrBkSttlmAmt": {
- "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n",
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
"type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
}
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "InstdAmt": {
- "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
"type": "string",
"pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
"example": 123.45
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
"title": "ActiveOrHistoricCurrencyCode",
"type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
"pattern": "^[A-Z]{3,3}$",
"example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "XchgRate": {
- "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n",
- "title": "BaseOneRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 0.7
- },
- "ChrgBr": {
- "description": "ChargeBearer\nSpecifies which party/parties will bear the charges associated with the processing of the payment transaction.\n",
- "title": "ChargeBearerType1Code",
- "type": "string",
- "enum": [
- "DEBT",
- "CRED",
- "SHAR",
- "SLEV"
- ],
- "example": "DEBT"
- },
- "ChrgsInf": {
- "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction\n",
- "title": "Charges16",
- "type": "object",
- "properties": {
- "Amt": {
- "description": "Amount\n\n Transaction charges to be paid by the charge bearer.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "TaxRecordPeriod1Code": {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ "TermsRequest_FIToFICustomerCreditProposal": {
+ "title": "TermsRequest_FIToFICustomerCreditProposal",
+ "type": "object",
+ "description": "This message is sent by a financial institution to a financial institution to propose the terms of a credit to a customer.\n",
+ "properties": {
+ "GrpHdr": {
+ "allOf": [
+ {
+ "title": "GroupHeader129",
+ "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n",
+ "type": "object",
+ "properties": {
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Agt": {
- "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ {
+ "description": "Message Identification\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Creation Date and Time\n"
+ }
+ ]
+ },
+ "PmtInstrXpryDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Payment Instruction Expiry Date and Time\n"
+ }
+ ]
+ },
+ "NbOfTxs": {
+ "allOf": [
+ {
+ "title": "Max15NumericText",
+ "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
+ "type": "string",
+ "pattern": "^[0-9]{1,15}$",
+ "example": 123456789012345
+ },
+ {
+ "description": "Number of Transactions\n"
+ }
+ ]
+ },
+ "SttlmInf": {
+ "allOf": [
+ {
+ "title": "SettlementInstruction15",
+ "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
+ "type": "object",
+ "properties": {
+ "SttlmMtd": {
+ "title": "SettlementMethod1Code",
+ "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n",
+ "type": "string",
+ "enum": [
+ "INDA",
+ "INGA",
+ "COVE",
+ "CLRG"
+ ],
+ "example": "CLRG"
+ },
+ "PmtTpInf": {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
+ "type": "object",
+ "properties": {
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "SEPA"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
+ {
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ "Prtry"
+ ]
}
- },
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "ADDR"
+ "Cd": "CASH"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
}
},
"example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
}
}
}
},
"required": [
- "FinInstnId"
+ "SttlmMtd"
],
"example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Tp": {
- "description": "Type\n\n Defines the type of charges.\n",
- "title": "ChargeType3Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCharge type, in a coded form.\n",
- "title": "ExternalChargeType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n",
- "title": "GenericIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
+ "SttlmMtd": "INDA",
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "SvcLvl": {
+ "Cd": "SEPA"
},
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
+ "LclInstrm": {
+ "Cd": "CH03"
+ },
+ "CtgyPurp": {
+ "Cd": "SUPP"
+ },
+ "Cdtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "AdrLine": "Address",
+ "Ctry": "CH"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN",
+ "Issr": "BIC"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "CH",
+ "CtctDtls": {
+ "Nm": "Name",
+ "PhneNb": 123,
+ "EmailAdr": null
+ }
+ }
}
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "required": [
- "Amt",
- "Agt"
- ],
- "example": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
}
},
- "Tp": {
- "Cd": "SHAR"
+ {
+ "description": "Settlement Information\n"
}
- }
+ ]
},
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction67",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
"type": "object",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "TxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
+ }
+ ]
+ },
+ "UETR": {
+ "allOf": [
+ {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ {
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
+ }
+ ]
+ },
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "TxId"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
}
+ },
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "PmtTpInf": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
+ "type": "object",
+ "properties": {
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- },
- "oneOf": [
+ ]
+ }
+ },
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
+ }
+ ]
+ },
+ "InstdAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
},
{
- "required": [
- "Prtry"
- ]
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
+ },
+ {
+ "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n"
}
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
+ ]
+ },
+ "XchgRate": {
+ "allOf": [
+ {
+ "title": "BaseOneRate",
+ "type": "string",
+ "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 0.7
+ },
+ {
+ "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n"
}
- }
+ ]
},
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
+ "ChrgBr": {
+ "title": "ChargeBearerType1Code",
+ "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n",
+ "type": "string",
+ "enum": [
+ "DEBT",
+ "CRED",
+ "SHAR",
+ "SLEV"
+ ],
+ "example": "DEBT"
+ },
+ "ChrgsInf": {
+ "allOf": [
+ {
+ "title": "Charges16",
+ "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n",
"type": "object",
"properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\nTransaction charges to be paid by the charge bearer.\n"
+ }
+ ]
},
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n"
+ }
+ ]
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ChargeType3Choice",
+ "description": "ChargeType3Choice\nSpecifies the type of charge.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalChargeType1Code",
+ "description": "Specifies the type of charge applied to the transaction.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCharge type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification3",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "Type\nDefines the type of charges.\n"
+ }
+ ]
}
},
"required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
+ "Amt",
+ "Agt"
],
"example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
}
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
+ {
+ "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n"
+ }
+ ]
+ },
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 140,
+ "example": 12345
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
}
},
"required": [
"Id"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
},
- "Issr": "BIC"
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
}
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ {
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
}
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
]
},
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "DbtrAcct": {
- "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
+ "DbtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
+ },
+ {
+ "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n"
+ }
+ ]
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
]
}
+ },
+ "required": [
+ "FinInstnId"
],
"example": {
- "Cd": "CHQB"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "CdtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
}
+ },
+ "required": [
+ "FinInstnId"
],
"example": {
- "Cd": "ADDR"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
+ }
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "ADDR"
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ ]
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
"type": "object",
"properties": {
"Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "CHQB"
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ ]
+ },
+ "InstrForNxtAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForNextAgent1",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
"Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "allOf": [
+ {
+ "title": "Instruction4Code",
+ "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "enum": [
+ "PHOA",
+ "TELA"
+ ],
+ "example": "PHOA"
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 140,
+ "example": 12345
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ ]
}
},
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "ADDR"
+ "Cd": "CH03"
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
+ "RgltryRptg": {
+ "allOf": [
+ {
+ "title": "RegulatoryReporting3",
+ "description": "Information needed due to regulatory and/or statutory requirements.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "DbtCdtRptgInd": {
+ "allOf": [
+ {
+ "title": "RegulatoryReportingType1Code",
+ "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n",
+ "type": "string",
+ "enum": [
+ "CRED",
+ "DEBT",
+ "BOTH"
+ ],
+ "example": "BOTH"
+ },
+ {
+ "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Authrty": {
+ "allOf": [
+ {
+ "title": "RegulatoryAuthority2",
+ "description": "Information about an entity requiring the regulatory reporting information.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ }
+ },
+ {
+ "description": "Authority\n\nEntity requiring the regulatory reporting information.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Dtls": {
+ "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
+ "anyOf": [
+ {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ {
+ "items": {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ "type": "array"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "BIC"
+ "DbtCdtRptgInd": "CRED",
+ "Authrty": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ },
+ "Dtls": {
+ "Cd": "A1",
+ "Inf": "Mandatory regulatory information"
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "Tax": {
+ "allOf": [
+ {
+ "title": "TaxData1",
+ "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "TaxParty1",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the creditor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT"
+ }
+ },
+ {
+ "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
},
- "Issr": {
+ {
+ "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n"
+ }
+ ]
+ },
+ "UltmtDbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
+ },
+ {
+ "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n"
+ }
+ ]
+ },
+ "AdmstnZone": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -105468,11151 +141436,21028 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "SchmeNm": {
+ {
+ "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n"
+ }
+ ]
+ },
+ "RefNb": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n"
+ }
+ ]
+ },
+ "Mtd": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "TtlTaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "TtlTaxAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate by which tax is due.\n"
+ }
+ ]
+ },
+ "SeqNb": {
+ "allOf": [
+ {
+ "title": "Number",
+ "type": "string",
+ "pattern": "^[\\d\\-\\.\\,]{1,18}$",
+ "example": 256
+ },
+ {
+ "description": "SequenceNumber\n\nSequential number of the tax report.\n"
+ }
+ ]
+ },
+ "Rcrd": {
+ "description": "Record\n\nDetails of the tax record.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ "type": "array"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Cdtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "Dbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "UltmtDbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "AdmstnZone": "CH",
+ "RefNb": 12345,
+ "Mtd": "A",
+ "TtlTaxblBaseAmt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "TtlTaxAmt": {
+ "Ccy": "CHF",
+ "Amt": 100
+ },
+ "Dt": "2018-01-01",
+ "SeqNb": 1,
+ "Rcrd": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
}
+ },
+ {
+ "description": "Tax\nProvides details on the tax.\n"
}
- },
+ ]
+ },
+ "VrfctnOfTerms": {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
+ "type": "string",
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
+ },
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
+ "IlpV4PrepPacket"
]
},
{
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "SHA-256 signature of the terms\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
+ "Sh256Sgntr"
]
}
],
"example": {
- "Cd": "ADDR"
+ "IlpV4PrepPacket": "1234567890ABCDEF"
}
+ }
+ },
+ "required": [
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "ChrgBr",
+ "Dbtr",
+ "DbtrAgt",
+ "CdtrAgt",
+ "Cdtr"
+ ],
+ "example": {
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ },
+ "SeqTp": "SEQTP"
},
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "IntrBkSttlmAmt": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
},
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "InstdAmt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
},
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "XchgRate": 123.45,
+ "ChrgBr": "SHAR",
+ "ChrgsInf": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
},
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "Dbtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
},
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
},
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "DbtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
},
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "CdtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
},
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
+ "Cdtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
},
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
},
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "InstrForCdtrAgt": {
+ "Cd": "CODE"
},
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "InstrForNxtAgt": {
+ "Cd": "CODE"
},
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Purp": {
+ "Cd": "CASH"
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "RgltryRptg": {
+ "Dbtr": true,
+ "Cdtr": true
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "Tax": "Cdtr"
}
},
+ {
+ "description": "Credit Transfer Transaction Information\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MsgId",
+ "CreDtTm",
+ "NbOfTxs",
+ "SttlmInf",
+ "CdtTrfTxInf"
+ ],
+ "example": {
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "SttlmInf": {
+ "SttlmMtd": "INDA",
+ "SttlmAcct": {
"Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
+ "IBAN": 123
+ }
+ },
+ "SttlmAcctOwnr": {
+ "Nm": "John Doe"
+ },
+ "SttlmAcctSvcr": {
+ "BICFI": 123
+ }
+ },
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": 123,
+ "EndToEndId": 123
+ },
+ "PmtTpInf": {
+ "InstrPrty": "NORM"
+ },
+ "InstdAmt": {
+ "Amt": 123,
+ "Ccy": "EUR"
+ },
+ "ChrgBr": "SLEV",
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": 123
+ }
+ },
+ "Cdtr": {
+ "Nm": "John Doe"
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": 123
+ }
+ },
+ "RmtInf": {
+ "Ustrd": "Test"
+ }
+ }
+ }
+ },
+ {
+ "description": "Group Header\nSet of characteristics shared by all individual transactions included in the message.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "GrpHdr"
+ ],
+ "example": {
+ "GrpHdr": {
+ "MsgId": 123456789,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "CtrlSum": 100,
+ "InitgPty": {
+ "Nm": "Initiating Party Name",
+ "Id": {
+ "OrgId": {
+ "Othr": [
+ {
+ "Id": 123456789,
+ "SchmeNm": {
+ "Cd": "BBA",
+ "Prtry": "Party Identification Scheme Name"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "FwdgAgt": {
+ "FinInstnId": {
+ "BICFI": "BBBBBBBB"
+ }
+ }
+ }
+ }
+ },
+ "TermsResponse_FIToFICustomerCreditConfirmation": {
+ "title": "TermsResponse_FIToFICustomerCreditConfirmation",
+ "type": "object",
+ "description": "This message is sent by the initiating party to the executing party, directly or through one or more intermediaries, to confirm the credit transfer transaction.\n",
+ "properties": {
+ "GrpHdr": {
+ "allOf": [
+ {
+ "title": "GroupHeader129",
+ "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n",
+ "type": "object",
+ "properties": {
+ "MsgId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Message Identification\n"
+ }
+ ]
+ },
+ "CreDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Creation Date and Time\n"
+ }
+ ]
+ },
+ "PmtInstrXpryDtTm": {
+ "allOf": [
+ {
+ "title": "ISODateTime",
+ "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n",
+ "type": "string",
+ "format": "datetime",
+ "example": "2013-03-07T14:44:30.000Z"
+ },
+ {
+ "description": "Payment Instruction Expiry Date and Time\n"
+ }
+ ]
+ },
+ "NbOfTxs": {
+ "allOf": [
+ {
+ "title": "Max15NumericText",
+ "description": "Specifies a numeric string with a maximum length of 15 digits.\n",
+ "type": "string",
+ "pattern": "^[0-9]{1,15}$",
+ "example": 123456789012345
+ },
+ {
+ "description": "Number of Transactions\n"
+ }
+ ]
+ },
+ "SttlmInf": {
+ "allOf": [
+ {
+ "title": "SettlementInstruction15",
+ "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n",
"type": "object",
"properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
+ "SttlmMtd": {
+ "title": "SettlementMethod1Code",
+ "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n",
+ "type": "string",
+ "enum": [
+ "INDA",
+ "INGA",
+ "COVE",
+ "CLRG"
+ ],
+ "example": "CLRG"
+ },
+ "PmtTpInf": {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
"type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
},
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
"type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
},
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "CH03"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
},
- "Issr": "BIC"
- }
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
}
},
"example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
}
}
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ }
+ },
+ "required": [
+ "SttlmMtd"
+ ],
+ "example": {
+ "SttlmMtd": "INDA",
+ "PmtTpInf": {
+ "InstrPrty": "NORM",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CH03"
+ },
+ "CtgyPurp": {
+ "Cd": "SUPP"
+ },
+ "Cdtr": {
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "AdrLine": "Address",
+ "Ctry": "CH"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN",
+ "Issr": "BIC"
+ }
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
}
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
+ "CtryOfRes": "CH",
+ "CtctDtls": {
+ "Nm": "Name",
+ "PhneNb": 123,
+ "EmailAdr": null
+ }
+ }
+ }
+ }
+ },
+ {
+ "description": "Settlement Information\n"
+ }
+ ]
+ },
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction67",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
+ "type": "object",
+ "properties": {
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
+ "InstrId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
+ "EndToEndId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Prtry": {
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "UETR": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
}
- ],
- "example": {
- "Cd": "CCPT"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
+ ]
}
},
"required": [
- "Id"
+ "TxId"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
}
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
]
},
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
+ "type": "object",
+ "properties": {
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "SEPA"
+ }
+ },
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
+ "type": "object",
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CH03"
+ }
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
+ }
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
+ {
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
+ },
+ "LclInstrm": {
+ "Cd": "CORE"
+ },
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
},
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
+ {
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
}
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "CdtrAcct": {
- "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
"type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
+ }
+ ]
+ },
+ "InstdAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
]
}
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
],
"example": {
- "Cd": 1111
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "XchgRate": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "BaseOneRate",
+ "type": "string",
+ "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 0.7
},
{
- "required": [
- "Prtry"
- ]
+ "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n"
}
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
+ ]
},
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "InstrForNxtAgt": {
- "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForNextAgent1",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
- "title": "Instruction4Code",
- "type": "string",
- "enum": [
- "PHOA",
- "TELA"
- ],
- "example": "PHOA"
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone"
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "RgltryRptg": {
- "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n",
- "title": "RegulatoryReporting3",
- "type": "object",
- "properties": {
- "DbtCdtRptgInd": {
- "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "title": "RegulatoryReportingType1Code",
- "type": "string",
- "enum": [
- "CRED",
- "DEBT",
- "BOTH"
- ],
- "example": "BOTH"
- },
- "Authrty": {
- "description": "Authority\n\nEntity requiring the regulatory reporting information.\n",
- "title": "RegulatoryAuthority2",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "ChrgBr": {
+ "title": "ChargeBearerType1Code",
+ "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n",
"type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "enum": [
+ "DEBT",
+ "CRED",
+ "SHAR",
+ "SLEV"
+ ],
+ "example": "DEBT"
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "example": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- }
- },
- "Dtls": {
- "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "anyOf": [
- {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
+ "ChrgsInf": {
+ "allOf": [
+ {
+ "title": "Charges16",
+ "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n",
"type": "object",
"properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\nTransaction charges to be paid by the charge bearer.\n"
+ }
+ ]
+ },
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n"
+ }
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ChargeType3Choice",
+ "description": "ChargeType3Choice\nSpecifies the type of charge.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalChargeType1Code",
+ "description": "Specifies the type of charge applied to the transaction.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCharge type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification3",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "Type\nDefines the type of charges.\n"
+ }
+ ]
}
},
"required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
+ "Amt",
+ "Agt"
],
"example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
},
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- },
- {
- "items": {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "FinInstnId": {
+ "BICFI": "BICFI"
}
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ "Tp": {
+ "Cd": "SHAR"
}
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
- ]
}
},
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "DbtCdtRptgInd": "CRED",
- "Authrty": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- },
- "Dtls": {
- "Cd": "A1",
- "Inf": "Mandatory regulatory information"
- }
- }
- },
- "Tax": {
- "description": "Tax\nProvides details on the tax.\n",
- "title": "TaxData1",
- "type": "object",
- "properties": {
- "Cdtr": {
- "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n",
- "title": "TaxParty1",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT"
- }
- },
- "Dbtr": {
- "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "UltmtDbtr": {
- "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ {
+ "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n"
}
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "AdmstnZone": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RefNb": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Mtd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TtlTaxblBaseAmt": {
- "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlTaxAmt": {
- "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dt": {
- "description": "Date\n\nDate by which tax is due.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "SeqNb": {
- "description": "SequenceNumber\n\nSequential number of the tax report\n",
- "title": "Number",
- "type": "string",
- "pattern": "^[\\d\\-\\.\\,]{1,18}$",
- "example": 256
- },
- "Rcrd": {
- "description": "Record\n\nDetails of the tax record.\n",
- "anyOf": [
- {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
+ ]
},
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
},
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
}
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ ]
},
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
+ "CtctDtls": {
+ "allOf": [
{
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
"type": "object",
"properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
"type": "object",
"properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
}
},
"required": [
- "FrDt",
- "ToDt"
+ "ChanlTp"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "ChanlTp": "PHON",
+ "Id": 1234567890
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
"type": "string",
"enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
],
- "example": "HLF1"
+ "example": "MAIL"
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
}
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
+ }
+ ]
+ },
+ "DbtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
}
- }
+ },
+ "required": [
+ "IBAN"
+ ]
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
+ {
"properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
}
},
"required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
+ "Othr"
+ ]
}
- },
- "required": [
- "Amt"
],
"example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ "IBAN": "BE71096123456769"
}
},
{
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
}
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ ]
}
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
}
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ {
+ "description": "Type\nType of the proxy identification.\n"
}
- }
+ ]
},
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
}
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ ]
}
},
- "type": "array"
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
]
}
},
"example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
+ "Tp": {
+ "Cd": "CACC"
},
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
}
}
},
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n"
}
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
+ ]
},
- {
- "items": {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
},
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
}
},
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
}
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
}
- }
+ ]
},
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
}
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
+ "AdrTp": {
+ "title": "AddressType3Choice",
"type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "FrDt",
- "ToDt"
],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "Cd": "ADDR"
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
"example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
"type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
"properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
}
},
"required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
+ "Id"
],
"example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
}
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
}
- }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
},
- "type": "array"
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
- ]
- }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
},
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
},
- "Inf": 12345
- }
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
}
},
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Cdtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "Dbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "UltmtDbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "AdmstnZone": "CH",
- "RefNb": 12345,
- "Mtd": "A",
- "TtlTaxblBaseAmt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "TtlTaxAmt": {
- "Ccy": "CHF",
- "Amt": 100
- },
- "Dt": "2018-01-01",
- "SeqNb": 1,
- "Rcrd": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
- },
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "ChrgBr",
- "Dbtr",
- "DbtrAgt",
- "CdtrAgt",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- },
- "SeqTp": "SEQTP"
- },
- "IntrBkSttlmAmt": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "InstdAmt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "XchgRate": 123.45,
- "ChrgBr": "SHAR",
- "ChrgsInf": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- },
- "Dbtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "CODE"
- },
- "InstrForNxtAgt": {
- "Cd": "CODE"
- },
- "Purp": {
- "Cd": "CASH"
- },
- "RgltryRptg": {
- "Dbtr": true,
- "Cdtr": true
- },
- "Tax": "Cdtr"
- }
- }
- },
- "required": [
- "MsgId",
- "CreDtTm",
- "NbOfTxs",
- "SttlmInf",
- "CdtTrfTxInf"
- ],
- "example": {
- "MsgId": 12345,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "SttlmInf": {
- "SttlmMtd": "INDA",
- "SttlmAcct": {
- "Id": {
- "IBAN": 123
- }
- },
- "SttlmAcctOwnr": {
- "Nm": "John Doe"
- },
- "SttlmAcctSvcr": {
- "BICFI": 123
- }
- },
- "CdtTrfTxInf": {
- "PmtId": {
- "InstrId": 123,
- "EndToEndId": 123
- },
- "PmtTpInf": {
- "InstrPrty": "NORM"
- },
- "InstdAmt": {
- "Amt": 123,
- "Ccy": "EUR"
- },
- "ChrgBr": "SLEV",
- "CdtrAgt": {
- "FinInstnId": {
- "BICFI": 123
- }
- },
- "Cdtr": {
- "Nm": "John Doe"
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": 123
- }
- },
- "RmtInf": {
- "Ustrd": "Test"
- }
- }
- }
- },
- "CdtTrfTxInf": {
- "title": "CreditTransferTransaction67",
- "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
- "type": "object",
- "properties": {
- "PmtId": {
- "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n",
- "title": "PaymentIdentification13",
- "type": "object",
- "properties": {
- "InstrId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "EndToEndId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "UETR": {
- "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n",
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "ClrSysRef": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "EndToEndId"
- ],
- "example": {
- "InstrId": "INSTRUCTIONID",
- "EndToEndId": "ENDTOENDID",
- "TxId": "TRANSACTIONID",
- "UETR": "123e4567-e89b-12d3-a456-426614174000",
- "ClrSysRef": "CLRSYSREF"
- }
- },
- "PmtTpInf": {
- "description": "PaymentTypeInformation\n\n Set of elements used to further specify the type of transaction.\n",
- "title": "PaymentTypeInformation28",
- "type": "object",
- "properties": {
- "InstrPrty": {
- "description": "InstructionPriority\nIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
- "title": "Priority2Code",
- "type": "string",
- "enum": [
- "HIGH",
- "NORM"
- ],
- "example": "HIGH"
- },
- "ClrChanl": {
- "description": "ClearingChannel\nSpecifies the clearing channel to be used to process the payment instruction.\n",
- "title": "ClearingChannel2Code",
- "type": "string",
- "enum": [
- "RTGS",
- "RTNS",
- "MPNS",
- "BOOK"
- ],
- "example": "RTGS"
- },
- "SvcLvl": {
- "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n",
- "title": "ServiceLevel8Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n",
- "title": "ExternalServiceLevel1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "SEPA"
- }
- },
- "LclInstrm": {
- "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n",
- "title": "LocalInstrument2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n",
- "title": "ExternalLocalInstrument1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "CtgyPurp": {
- "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n",
- "title": "CategoryPurpose1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCategory purpose, as published in an external category purpose code list.\n",
- "maxLength": 4,
- "minLength": 1,
- "type": "string",
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "example": {
- "InstrPrty": "NORM",
- "ClrChanl": "RTGS",
- "SvcLvl": {
- "Cd": "SEPA"
- },
- "LclInstrm": {
- "Cd": "CORE"
- },
- "CtgyPurp": {
- "Cd": "CASH"
- }
- }
- },
- "IntrBkSttlmAmt": {
- "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n",
- "title": "ActiveCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveCurrencyAndAmount": {
- "title": "ActiveCurrencyAndAmount_SimpleType",
- "type": "string",
- "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "InstdAmt": {
- "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "XchgRate": {
- "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n",
- "title": "BaseOneRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 0.7
- },
- "ChrgBr": {
- "description": "ChargeBearer\nSpecifies which party/parties will bear the charges associated with the processing of the payment transaction.\n",
- "title": "ChargeBearerType1Code",
- "type": "string",
- "enum": [
- "DEBT",
- "CRED",
- "SHAR",
- "SLEV"
- ],
- "example": "DEBT"
- },
- "ChrgsInf": {
- "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction\n",
- "title": "Charges16",
- "type": "object",
- "properties": {
- "Amt": {
- "description": "Amount\n\n Transaction charges to be paid by the charge bearer.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Agt": {
- "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "required": [
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
+ }
+ ]
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
+ "CdtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
]
}
+ },
+ "required": [
+ "FinInstnId"
],
"example": {
- "Cd": "CHQB"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
}
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ ]
+ },
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
+ }
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Id": {
+ "IBAN": "BE71096123456769"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "Tp": {
+ "Cd": "CACC"
},
- {
- "required": [
- "Prtry"
- ]
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
}
- ],
- "example": {
- "Cd": "BIC"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
"Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "ADDR"
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- }
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Tp": {
- "description": "Type\n\n Defines the type of charges.\n",
- "title": "ChargeType3Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCharge type, in a coded form.\n",
- "title": "ExternalChargeType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n",
- "title": "GenericIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CASH"
- }
- }
- },
- "required": [
- "Amt",
- "Agt"
- ],
- "example": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- }
- },
- "Dbtr": {
- "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
- "type": "object",
- "properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
},
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "InstrForNxtAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForNextAgent1",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
"type": "object",
"properties": {
"Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "allOf": [
+ {
+ "title": "Instruction4Code",
+ "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n",
+ "type": "string",
+ "enum": [
+ "PHOA",
+ "TELA"
+ ],
+ "example": "PHOA"
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
}
},
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "BIC"
+ "Cd": "CH03"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
+ },
+ "RgltryRptg": {
+ "allOf": [
+ {
+ "title": "RegulatoryReporting3",
+ "description": "Information needed due to regulatory and/or statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "DbtCdtRptgInd": {
+ "allOf": [
+ {
+ "title": "RegulatoryReportingType1Code",
+ "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n",
+ "type": "string",
+ "enum": [
+ "CRED",
+ "DEBT",
+ "BOTH"
+ ],
+ "example": "BOTH"
+ },
+ {
+ "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n"
+ }
+ ]
+ },
+ "Authrty": {
+ "allOf": [
+ {
+ "title": "RegulatoryAuthority2",
+ "description": "Information about an entity requiring the regulatory reporting information.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ }
+ },
+ {
+ "description": "Authority\n\nEntity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
+ "anyOf": [
+ {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ {
+ "items": {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DbtCdtRptgInd": "CRED",
+ "Authrty": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ },
+ "Dtls": {
+ "Cd": "A1",
+ "Inf": "Mandatory regulatory information"
+ }
+ }
},
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "Tax": {
+ "allOf": [
+ {
+ "title": "TaxData1",
+ "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "TaxParty1",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the creditor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT"
+ }
+ },
+ {
+ "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n"
+ }
+ ]
+ },
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
+ },
+ {
+ "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n"
+ }
+ ]
+ },
+ "UltmtDbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
+ },
+ {
+ "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n"
+ }
+ ]
+ },
+ "AdmstnZone": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n"
+ }
+ ]
+ },
+ "RefNb": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n"
+ }
+ ]
+ },
+ "Mtd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n"
+ }
+ ]
+ },
+ "TtlTaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlTaxAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate by which tax is due.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "SeqNb": {
+ "allOf": [
+ {
+ "title": "Number",
+ "type": "string",
+ "pattern": "^[\\d\\-\\.\\,]{1,18}$",
+ "example": 256
+ },
+ {
+ "description": "SequenceNumber\n\nSequential number of the tax report.\n"
+ }
+ ]
+ },
+ "Rcrd": {
+ "description": "Record\n\nDetails of the tax record.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ "type": "array"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "CCPT"
+ "Cdtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "Dbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "UltmtDbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ },
+ "AdmstnZone": "CH",
+ "RefNb": 12345,
+ "Mtd": "A",
+ "TtlTaxblBaseAmt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "TtlTaxAmt": {
+ "Ccy": "CHF",
+ "Amt": 100
+ },
+ "Dt": "2018-01-01",
+ "SeqNb": 1,
+ "Rcrd": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Tax\nProvides details on the tax.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "DbtrAcct": {
- "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
+ "VrfctnOfTerms": {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
"oneOf": [
{
+ "properties": {
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
+ "type": "string",
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
+ },
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
+ "IlpV4PrepPacket"
]
},
{
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
+ {
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
+ },
+ {
+ "description": "SHA-256 signature of the terms\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
+ "Sh256Sgntr"
]
}
],
"example": {
- "Cd": 1111
+ "IlpV4PrepPacket": "1234567890ABCDEF"
}
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
}
},
"required": [
- "Id"
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "ChrgBr",
+ "Dbtr",
+ "DbtrAgt",
+ "CdtrAgt",
+ "Cdtr"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
},
- "Issr": "BIC"
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ },
+ "SeqTp": "SEQTP"
+ },
+ "IntrBkSttlmAmt": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "InstdAmt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "XchgRate": 123.45,
+ "ChrgBr": "SHAR",
+ "ChrgsInf": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
+ },
+ "Dbtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "CODE"
+ },
+ "InstrForNxtAgt": {
+ "Cd": "CODE"
+ },
+ "Purp": {
+ "Cd": "CASH"
+ },
+ "RgltryRptg": {
+ "Dbtr": true,
+ "Cdtr": true
+ },
+ "Tax": "Cdtr"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
},
{
- "required": [
- "Othr"
- ]
+ "description": "Credit Transfer Transaction Information\n"
}
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
+ }
+ },
+ "required": [
+ "MsgId",
+ "CreDtTm",
+ "NbOfTxs",
+ "SttlmInf",
+ "CdtTrfTxInf"
+ ],
+ "example": {
+ "MsgId": 12345,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "SttlmInf": {
+ "SttlmMtd": "INDA",
+ "SttlmAcct": {
+ "Id": {
+ "IBAN": 123
}
},
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
+ "SttlmAcctOwnr": {
+ "Nm": "John Doe"
+ },
+ "SttlmAcctSvcr": {
+ "BICFI": 123
}
},
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
+ "CdtTrfTxInf": {
+ "PmtId": {
+ "InstrId": 123,
+ "EndToEndId": 123
+ },
+ "PmtTpInf": {
+ "InstrPrty": "NORM"
+ },
+ "InstdAmt": {
+ "Amt": 123,
+ "Ccy": "EUR"
+ },
+ "ChrgBr": "SLEV",
+ "CdtrAgt": {
+ "FinInstnId": {
+ "BICFI": 123
+ }
+ },
+ "Cdtr": {
+ "Nm": "John Doe"
+ },
+ "CdtrAcct": {
"Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ "IBAN": 123
}
},
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
+ "RmtInf": {
+ "Ustrd": "Test"
}
}
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
}
},
- "DbtrAgt": {
- "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
+ {
+ "description": "Group Header\nSet of characteristics shared by all individual transactions included in the message.\n"
+ }
+ ]
+ },
+ "CdtTrfTxInf": {
+ "allOf": [
+ {
+ "title": "CreditTransferTransaction67",
+ "description": "Provides further details specific to the individual transaction(s) included in the message.\n",
"type": "object",
"properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
+ "PmtId": {
+ "allOf": [
+ {
+ "title": "PaymentIdentification13",
+ "description": "Provides further means of referencing a payment transaction.\n",
"type": "object",
"properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
- },
- "Prtry": {
+ "InstrId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ ]
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "EndToEndId": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
},
- "Prtry": {
+ {
+ "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n"
+ }
+ ]
+ },
+ "TxId": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "UETR": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "ClrSysRef": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n"
+ }
+ ]
}
},
"required": [
- "Id"
+ "TxId"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
+ "InstrId": "INSTRUCTIONID",
+ "EndToEndId": "ENDTOENDID",
+ "TxId": "TRANSACTIONID",
+ "UETR": "123e4567-e89b-12d3-a456-426614174000",
+ "ClrSysRef": "CLRSYSREF"
}
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
+ {
+ "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n"
}
- }
+ ]
},
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ "PmtTpInf": {
+ "allOf": [
+ {
+ "title": "PaymentTypeInformation28",
+ "description": "Provides further details of the type of payment.\n",
"type": "object",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
+ "InstrPrty": {
+ "title": "Priority2Code",
+ "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n",
+ "type": "string",
+ "enum": [
+ "HIGH",
+ "NORM"
+ ],
+ "example": "HIGH"
+ },
+ "ClrChanl": {
+ "title": "ClearingChannel2Code",
+ "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n",
+ "type": "string",
+ "enum": [
+ "RTGS",
+ "RTNS",
+ "MPNS",
+ "BOOK"
+ ],
+ "example": "RTGS"
+ },
+ "SvcLvl": {
+ "allOf": [
+ {
+ "title": "ServiceLevel8Choice",
+ "description": "Details about a service level.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalServiceLevel1Code",
+ "description": "Specifies the external service level code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
],
- "type": "string",
- "example": "ADDR"
+ "example": {
+ "Cd": "SEPA"
+ }
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n"
+ }
+ ]
+ },
+ "LclInstrm": {
+ "allOf": [
+ {
+ "title": "LocalInstrument2Choice",
"type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalLocalInstrument1Code",
+ "description": "Specifies the external local instrument identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 12345
+ },
+ {
+ "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "Id",
- "Issr"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Cd": "CH03"
}
+ },
+ {
+ "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "CtgyPurp": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "CategoryPurpose1Choice",
+ "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n",
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": 1234
+ },
+ {
+ "description": "Code\nCategory purpose, as published in an external category purpose code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nCategory purpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
+ }
+ },
+ "example": {
+ "InstrPrty": "NORM",
+ "ClrChanl": "RTGS",
+ "SvcLvl": {
+ "Cd": "SEPA"
},
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "LclInstrm": {
+ "Cd": "CORE"
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "CtgyPurp": {
+ "Cd": "CASH"
+ }
+ }
+ },
+ {
+ "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n"
+ }
+ ]
+ },
+ "IntrBkSttlmAmt": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ }
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveCurrencyCode",
+ "type": "string",
+ "pattern": "^[A-Z]{3,3}$",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
}
},
+ "required": [
+ "ActiveCurrencyAndAmount",
+ "Ccy"
+ ],
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n"
+ }
+ ]
+ },
+ "InstdAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
}
+ },
+ {
+ "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n"
}
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
+ ]
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "CdtrAgt": {
- "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n",
- "title": "BranchAndFinancialInstitutionIdentification8",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
- "title": "FinancialInstitutionIdentification23",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
+ "XchgRate": {
+ "allOf": [
+ {
+ "title": "BaseOneRate",
"type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
+ "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 0.7
},
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
+ {
+ "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n"
+ }
+ ]
+ },
+ "ChrgBr": {
+ "title": "ChargeBearerType1Code",
+ "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n",
+ "type": "string",
+ "enum": [
+ "DEBT",
+ "CRED",
+ "SHAR",
+ "SLEV"
+ ],
+ "example": "DEBT"
+ },
+ "ChrgsInf": {
+ "allOf": [
+ {
+ "title": "Charges16",
+ "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n",
"type": "object",
"properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Amount\nTransaction charges to be paid by the charge bearer.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "Agt": {
+ "allOf": [
{
+ "title": "BranchAndFinancialInstitutionIdentification8",
+ "type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
+ "properties": {
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
+ },
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
+ },
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "FinInstnId"
+ ],
+ "example": {
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
+ ]
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ChargeType3Choice",
+ "description": "ChargeType3Choice\nSpecifies the type of charge.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalChargeType1Code",
+ "description": "Specifies the type of charge applied to the transaction.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nCharge type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification3",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CASH"
+ }
+ },
+ {
+ "description": "Type\nDefines the type of charges.\n"
+ }
+ ]
}
},
"required": [
- "MmbId"
+ "Amt",
+ "Agt"
],
"example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
},
- "MmbId": 123456789
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Tp": {
+ "Cd": "SHAR"
+ }
}
},
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
+ {
+ "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n"
+ }
+ ]
+ },
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "example": "ADDR"
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "SchmeNm": {
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ ]
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- }
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
- "properties": {
"Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": {
- "Cd": "CHQB"
- },
- "MmbId": 123456789
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CHQB"
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\n\n Identifies a specific branch of a financial institution.\n",
- "title": "BranchData5",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "LEI\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
"type": "string",
- "example": "ADDR"
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "OtherContact\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
+ },
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
+ "required": [
+ "Id"
+ ],
"example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
+ },
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
}
+ },
+ {
+ "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n"
}
- },
- "example": {
- "Id": 123,
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "required": [
- "FinInstnId"
- ],
- "example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- },
- "Cdtr": {
- "description": "Creditor\nParty to which an amount of money is due.\n",
- "title": "PartyIdentification272",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
},
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress27",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "DbtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "ADDR"
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
},
- "CareOf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "UnitNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "TwnLctnNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "DstrctNm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "CareOf": "CareOf",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "UnitNb": "UnitNb",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a party.\n",
- "title": "Party52Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification39",
+ "DbtrAgt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification3",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification23",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
]
}
- ],
+ },
+ "required": [],
"example": {
- "Cd": "BIC"
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "Person\nUnique and unambiguous identification of a person, for example a passport\n",
- "title": "PersonIdentification18",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification2",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification of a person.\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
]
- }
- ],
- "example": {
- "Cd": "CCPT"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact13",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "URLAdr": {
- "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max256Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 256,
- "example": 256
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "OtherContact\nContact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod2Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "MAIL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "URLAdr": "http://www.example.com",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry"
- },
- "Id": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": null
- }
- }
- },
- "CdtrAcct": {
- "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
+ "FinInstnId"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- {
- "required": [
- "Prtry"
- ]
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
}
- ],
- "example": {
- "Cd": "CH03"
}
},
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
+ {
+ "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "InstrForCdtrAgt": {
- "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForCreditorAgent3",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n",
- "title": "ExternalCreditorAgentInstruction1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone."
- }
- },
- "InstrForNxtAgt": {
- "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n",
- "title": "InstructionForNextAgent1",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
- "title": "Instruction4Code",
- "type": "string",
- "enum": [
- "PHOA",
- "TELA"
- ],
- "example": "PHOA"
- },
- "InstrInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Cd": "PHOA",
- "InstrInf": "Please advise/contact next agent by phone"
- }
- },
- "Purp": {
- "description": "Purpose\nUnderlying reason for the payment transaction.\n",
- "title": "Purpose2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n",
- "title": "ExternalPurpose1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "RgltryRptg": {
- "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n",
- "title": "RegulatoryReporting3",
- "type": "object",
- "properties": {
- "DbtCdtRptgInd": {
- "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "title": "RegulatoryReportingType1Code",
- "type": "string",
- "enum": [
- "CRED",
- "DEBT",
- "BOTH"
- ],
- "example": "BOTH"
- },
- "Authrty": {
- "description": "Authority\n\nEntity requiring the regulatory reporting information.\n",
- "title": "RegulatoryAuthority2",
- "type": "object",
- "properties": {
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "example": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- }
},
- "Dtls": {
- "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
- "anyOf": [
+ "CdtrAgt": {
+ "allOf": [
{
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "title": "BranchAndFinancialInstitutionIdentification8",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
+ "FinInstnId": {
+ "allOf": [
{
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "title": "FinancialInstitutionIdentification23",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
},
{
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n"
}
]
- }
- },
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
},
- "Inf": 12345
- }
- },
- {
- "items": {
- "title": "StructuredRegulatoryReporting3",
- "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
- "type": "object",
- "properties": {
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dt": {
- "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "Cd": {
- "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n",
- "title": "Max10Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 10,
- "example": 1234567890
- },
- "Amt": {
- "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData5",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "type": "object",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "example": {
+ "Id": 123,
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number"
+ }
}
},
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
+ {
+ "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n"
}
- },
- "Inf": {
- "description": "Information\nAdditional details that cater for specific domestic regulatory requirements.\n",
- "anyOf": [
- {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- {
- "items": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Tp": "T1",
- "Dt": "2018-01-01",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "DbtCdtRptgInd": "CRED",
- "Authrty": {
- "Nm": "Swiss National Bank",
- "Ctry": "CH"
- },
- "Dtls": {
- "Cd": "A1",
- "Inf": "Mandatory regulatory information"
- }
- }
- },
- "Tax": {
- "description": "Tax\nProvides details on the tax.\n",
- "title": "TaxData1",
- "type": "object",
- "properties": {
- "Cdtr": {
- "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n",
- "title": "TaxParty1",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT"
- }
- },
- "Dbtr": {
- "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ ]
}
},
+ "required": [
+ "FinInstnId"
+ ],
"example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "UltmtDbtr": {
- "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n",
- "title": "TaxParty2",
- "type": "object",
- "properties": {
- "TaxId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RegnId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TaxTp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Authstn": {
- "description": "Authorisation\n\nDetails of the authorised tax paying party.\n",
- "title": "TaxAuthorisation1",
- "type": "object",
- "properties": {
- "Titl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "Nm": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- }
- },
- "example": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "example": {
- "TaxId": 123456789,
- "RegnId": 123456789,
- "TaxTp": "VAT",
- "Authstn": {
- "Titl": "Mr",
- "Nm": "John Doe"
- }
- }
- },
- "AdmstnZone": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "RefNb": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "Mtd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TtlTaxblBaseAmt": {
- "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlTaxAmt": {
- "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dt": {
- "description": "Date\n\nDate by which tax is due.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "SeqNb": {
- "description": "SequenceNumber\n\nSequential number of the tax report\n",
- "title": "Number",
- "type": "string",
- "pattern": "^[\\d\\-\\.\\,]{1,18}$",
- "example": 256
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
+ }
+ },
+ {
+ "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n"
+ }
+ ]
},
- "Rcrd": {
- "description": "Record\n\nDetails of the tax record.\n",
- "anyOf": [
+ "Cdtr": {
+ "allOf": [
{
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
+ "title": "PartyIdentification272",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
},
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress27",
"type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
"properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "CareOf": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "UnitNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "TwnLctnNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "DstrctNm": {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
}
},
- "required": [
- "FrDt",
- "ToDt"
- ],
"example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
+ "AdrTp": "ADDR",
+ "CareOf": "CareOf",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "UnitNb": "UnitNb",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
}
},
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party52Choice",
+ "description": "NOTE: Unsure on the description.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification39",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification3",
+ "type": "object",
+ "description": "Information related to an identification of an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification18",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification2",
+ "type": "object",
+ "description": "Identification of a person.",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
],
- "example": "HLF1"
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
},
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ {
+ "description": "Identification\nUnique and unambiguous identification of a party.\n"
}
- }
+ ]
},
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
"type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
+ {
+ "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
+ }
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact13",
+ "description": "Specifies the details of the contact person.\n",
"type": "object",
"properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "URLAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max256Text",
+ "description": "Specifies a character string with a maximum length of 256 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "example": 256
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
"type": "object",
"properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
"type": "string",
- "format": "date",
- "example": "2013-03-07"
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
},
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
}
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
}
},
"required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
+ "ChanlTp"
],
"example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ "ChanlTp": "PHON",
+ "Id": 1234567890
}
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
+ {
+ "description": "OtherContact\nContact details in another form.\n"
}
- }
+ ]
},
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod2Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "MAIL"
},
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
+ {
+ "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n"
}
- },
- "type": "array"
+ ]
}
- ]
- }
- },
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
},
- "Inf": 12345
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "URLAdr": "http://www.example.com",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n"
}
- }
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
+ "required": [
+ "Id"
+ ],
"example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry"
},
- "AddtlInf": "VAT applicable"
- }
- },
- {
- "items": {
- "title": "TaxRecord3",
- "description": "Set of elements used to define the tax record.\n",
- "type": "object",
- "properties": {
- "AddtlInf": {
- "title": "Max140Text",
- "description": "Specifies a character string with a maximum length of 140 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "CertId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctgy": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtgyDtls": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DbtrSts": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "FrmsCd": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "TaxAmt": {
- "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n",
- "title": "TaxAmount3",
- "type": "object",
- "properties": {
- "Rate": {
- "description": "Rate\n\nRate used to calculate the tax.\n",
- "title": "PercentageRate",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
- "example": 1234
- },
- "TaxblBaseAmt": {
- "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "TtlAmt": {
- "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- },
- "Dtls": {
- "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
- "anyOf": [
- {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
- },
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
- "type": "object",
- "properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
- },
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- }
- },
- "required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
- ],
- "example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- },
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
- }
- }
- },
- {
- "items": {
- "title": "TaxRecordDetails3",
- "description": "Details on the tax period and amount\n",
- "type": "object",
- "properties": {
- "Prd": {
- "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n",
- "title": "TaxPeriod3",
- "type": "object",
- "properties": {
- "FrToDt": {
- "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n",
- "title": "DatePeriod2",
- "type": "object",
- "properties": {
- "FrDt": {
- "description": "FromDate\nStart date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "ToDt": {
- "description": "ToDate\nEnd date of the range.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- }
- },
- "required": [
- "FrDt",
- "ToDt"
- ],
- "example": {
- "FrDt": "2022-01-01T00:00:00.000Z",
- "ToDt": "2022-12-31T23:59:59.999Z"
- }
- },
- "Tp": {
- "description": "Type\n\nIdentification of the period related to the tax payment.\n",
- "title": "TaxRecordPeriod1Code",
- "type": "string",
- "enum": [
- "MM01",
- "MM02",
- "MM03",
- "MM04",
- "MM05",
- "MM06",
- "MM07",
- "MM08",
- "MM09",
- "MM10",
- "MM11",
- "MM12",
- "QTR1",
- "QTR2",
- "QTR3",
- "QTR4",
- "HLF1",
- "HLF2"
- ],
- "example": "HLF1"
- },
- "Yr": {
- "description": "Year\n\nYear related to the tax payment.\n",
- "title": "ISOYear",
- "type": "string",
- "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
- "example": 2019
- }
- },
- "example": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
- }
- }
+ "Id": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ }
+ },
+ {
+ "description": "Creditor\nParty to which an amount of money is due.\n"
+ }
+ ]
+ },
+ "CdtrAcct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
+ "type": "object",
+ "description": "Provides the details to identify an account.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
},
- "Amt": {
- "description": "Amount\n\nUnderlying tax amount related to the specified period.\n",
- "title": "ActiveOrHistoricCurrencyAndAmount",
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
"type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
"properties": {
- "ActiveOrHistoricCurrencyAndAmount": {
- "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
- "type": "string",
- "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
- "example": 123.45
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
},
- "Ccy": {
- "description": "Currency\nIdentification of the currency in which the account is held.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
}
},
"required": [
- "ActiveOrHistoricCurrencyAndAmount",
- "Ccy"
+ "Id"
],
"example": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- }
- }
- },
- "required": [
- "Amt"
- ],
- "example": {
- "Prd": {
- "Yr": 2020,
- "Tp": "MM01",
- "FrToDt": {
- "FrDt": "2020-01-01",
- "ToDt": "2020-01-31"
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
}
},
- "Amt": {
- "Amt": 100,
- "Ccy": "EUR"
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
}
- }
- },
- "type": "array"
- }
- ]
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
}
},
- "example": {
- "Rate": 0,
- "TaxblBaseAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "TtlAmt": {
- "Ccy": "EUR",
- "Amt": 0
- },
- "Dtls": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
},
- "Inf": 12345
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
}
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
}
- },
- "Tp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
+ ]
},
- "example": {
- "Tp": "VAT",
- "Ctgy": "A",
- "CtgyDtls": "Standard",
- "DbtrSts": "Resident",
- "CertId": 123456789,
- "FrmsCd": 123456789,
- "Prd": {
- "FrstDay": "2019-01-01",
- "LastDay": "2019-12-31"
- },
- "TaxAmt": {
- "Rate": 0.2,
- "TaxblBaseAmt": 1000,
- "TtlAmt": 200
- },
- "AddtlInf": "VAT applicable"
- }
- },
- "type": "array"
- }
- ]
- }
- },
- "example": {
- "Cdtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "Dbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "UltmtDbtr": {
- "Titl": "Mr",
- "Nm": "John Doe"
- },
- "AdmstnZone": "CH",
- "RefNb": 12345,
- "Mtd": "A",
- "TtlTaxblBaseAmt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "TtlTaxAmt": {
- "Ccy": "CHF",
- "Amt": 100
- },
- "Dt": "2018-01-01",
- "SeqNb": 1,
- "Rcrd": {
- "Tp": "T1",
- "Ctry": "CH",
- "Cd": "CHF",
- "Amt": {
- "Ccy": "CHF",
- "Amt": 1000
- },
- "Inf": 12345
- }
- }
- },
- "VrfctnOfTerms": {
- "title": "CryptographicLockChoice",
- "description": "NOTE: Unsure on description.\n",
- "type": "object",
- "properties": {
- "IlpV4PrepPacket": {
- "title": "hexBinary",
- "type": "string",
- "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
- "example": 4660
- },
- "Sh256Sgntr": {
- "title": "Exact32HexBinaryText",
- "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
- "type": "string",
- "pattern": "^([0-9A-F][0-9A-F]){32}$",
- "example": "1234567890ABCDEF1234567890ABCDEF"
- }
- },
- "oneOf": [
- {
- "required": [
- "IlpV4PrepPacket"
- ]
- },
- {
- "required": [
- "Sh256Sgntr"
- ]
- }
- ],
- "example": {
- "IlpV4PrepPacket": "1234567890ABCDEF"
- }
- }
- },
- "required": [
- "PmtId",
- "IntrBkSttlmAmt",
- "ChrgBr",
- "Dbtr",
- "DbtrAgt",
- "CdtrAgt",
- "Cdtr"
- ],
- "example": {
- "PmtId": {
- "InstrId": "INSTRID",
- "EndToEndId": "ENDTOENDID"
- },
- "PmtTpInf": {
- "LclInstrm": {
- "Cd": "CHQB",
- "Prtry": "PROPRIETARY"
- },
- "SeqTp": "SEQTP"
- },
- "IntrBkSttlmAmt": {
- "ActiveCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "InstdAmt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "XchgRate": 123.45,
- "ChrgBr": "SHAR",
- "ChrgsInf": {
- "Amt": {
- "ActiveOrHistoricCurrencyAndAmount": 123.45,
- "Ccy": "USD"
- },
- "Agt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Tp": {
- "Cd": "SHAR"
- }
- },
- "Dbtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "DbtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "DbtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "CdtrAgt": {
- "BrnchId": {
- "Id": "BRANCHID"
- },
- "FinInstnId": {
- "BICFI": "BICFI"
- }
- },
- "Cdtr": {
- "Nm": "NAME",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "BldgNb": "BLDGNB",
- "Ctry": "CTRY",
- "TwnNm": "TWNNM",
- "PstCd": "PSTCD",
- "StrtNm": "STRTNM"
- }
- },
- "CdtrAcct": {
- "Id": {
- "IBAN": "IBAN"
- }
- },
- "InstrForCdtrAgt": {
- "Cd": "CODE"
- },
- "InstrForNxtAgt": {
- "Cd": "CODE"
- },
- "Purp": {
- "Cd": "CASH"
- },
- "RgltryRptg": {
- "Dbtr": true,
- "Cdtr": true
- },
- "Tax": "Cdtr"
- }
- }
- },
- "required": [
- "GrpHdr",
- "CdtTrfTxInf"
- ],
- "example": {
- "GrpHdr": {
- "MsgId": 123456789,
- "CreDtTm": "2020-01-01T00:00:00Z",
- "NbOfTxs": 1,
- "CtrlSum": 100,
- "InitgPty": {
- "Nm": "Initiating Party Name",
- "Id": {
- "OrgId": {
- "Othr": [
- {
- "Id": 123456789,
- "SchmeNm": {
- "Cd": "BBA",
- "Prtry": "Party Identification Scheme Name"
- }
- }
- ]
- }
- }
- },
- "FwdgAgt": {
- "FinInstnId": {
- "BICFI": "BBBBBBBB"
- }
- }
- }
- }
- },
- "UUIDv4Identifier": {
- "title": "UUIDv4Identifier",
- "type": "string",
- "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
- "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
- },
- "VerificationReason1Choice": {
- "title": "VerificationReason1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n",
- "title": "ExternalVerificationReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "AGNT"
- }
- },
- "VerificationReport4": {
- "title": "VerificationReport4",
- "type": "object",
- "properties": {
- "OrgnlId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Vrfctn": {
- "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n",
- "title": "IdentificationVerificationIndicator",
- "type": "boolean",
- "example": true
- },
- "Rsn": {
- "description": "Reason.\nSpecifies the reason why the verified identification information is incorrect.\n",
- "title": "VerificationReason1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n",
- "title": "ExternalVerificationReason1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "AGNT"
- }
- },
- "OrgnlPtyAndAcctId": {
- "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n",
- "title": "IdentificationInformation4",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n",
- "title": "PartyIdentification135",
- "type": "object",
- "properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
+ }
+ },
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
+ }
+ },
+ {
+ "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n"
+ }
+ ]
},
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "InstrForCdtrAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForCreditorAgent3",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
"Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "allOf": [
+ {
+ "title": "ExternalCreditorAgentInstruction1Code",
+ "description": "Specifies the instruction given by the creditor to the creditor agent.",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
+ "minLength": 1,
+ "maxLength": 4,
"example": 1234
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 140,
+ "example": 12345
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "InstrForNxtAgt": {
+ "allOf": [
+ {
+ "title": "InstructionForNextAgent1",
+ "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Instruction4Code",
+ "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n",
+ "type": "string",
+ "enum": [
+ "PHOA",
+ "TELA"
+ ],
+ "example": "PHOA"
+ },
+ {
+ "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n"
+ }
+ ]
+ },
+ "InstrInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
+ ]
}
},
+ "example": {
+ "Cd": "PHOA",
+ "InstrInf": "Please advise/contact next agent by phone."
+ }
+ },
+ {
+ "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n"
+ }
+ ]
+ },
+ "Purp": {
+ "allOf": [
+ {
+ "title": "Purpose2Choice",
+ "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPurpose1Code",
+ "description": "Specifies the external purpose code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
{
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\n\nPurpose, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Prtry"
]
}
],
"example": {
- "Cd": "ADDR"
+ "Cd": "CH03"
}
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "Purpose\nUnderlying reason for the payment transaction.\n"
+ }
+ ]
+ },
+ "RgltryRptg": {
+ "allOf": [
+ {
+ "title": "RegulatoryReporting3",
+ "description": "Information needed due to regulatory and/or statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "DbtCdtRptgInd": {
+ "allOf": [
+ {
+ "title": "RegulatoryReportingType1Code",
+ "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n",
+ "type": "string",
+ "enum": [
+ "CRED",
+ "DEBT",
+ "BOTH"
+ ],
+ "example": "BOTH"
+ },
+ {
+ "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n"
+ }
+ ]
+ },
+ "Authrty": {
+ "allOf": [
+ {
+ "title": "RegulatoryAuthority2",
+ "description": "Information about an entity requiring the regulatory reporting information.\n",
+ "type": "object",
+ "properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ }
+ },
+ {
+ "description": "Authority\n\nEntity requiring the regulatory reporting information.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n",
+ "anyOf": [
+ {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ {
+ "items": {
+ "title": "StructuredRegulatoryReporting3",
+ "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Ctry": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n"
+ }
+ ]
+ },
+ "Cd": {
+ "allOf": [
+ {
+ "title": "Max10Text",
+ "description": "Specifies a character string with a maximum length of 10 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 10,
+ "example": 1234567890
+ },
+ {
+ "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n"
+ }
+ ]
+ },
+ "Inf": {
+ "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n",
+ "anyOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "items": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "T1",
+ "Dt": "2018-01-01",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DbtCdtRptgInd": "CRED",
+ "Authrty": {
+ "Nm": "Swiss National Bank",
+ "Ctry": "CH"
+ },
+ "Dtls": {
+ "Cd": "A1",
+ "Inf": "Mandatory regulatory information"
+ }
+ }
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
+ "Tax": {
+ "allOf": [
+ {
+ "title": "TaxData1",
+ "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n",
"type": "object",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "Cdtr": {
+ "allOf": [
+ {
+ "title": "TaxParty1",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the creditor.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "BIC"
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT"
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
- }
- },
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
- "type": "object",
- "properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ {
+ "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n"
}
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
+ ]
},
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "Dbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
"type": "object",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
]
}
- ],
+ },
"example": {
- "Cd": "CCPT"
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
- },
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
- }
- }
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
- },
- {
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
- }
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
- }
- }
- }
- },
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
- }
- },
- "Acct": {
- "description": "Account\nUnambiguous identification of the account of a party.\n",
- "title": "CashAccount40",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "UltmtDbtr": {
+ "allOf": [
+ {
+ "title": "TaxParty2",
+ "description": "Details about the entity involved in the tax paid or to be paid.\n",
+ "type": "object",
+ "properties": {
+ "TaxId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxIdentification\n\nTax identification number of the debtor.\n"
+ }
+ ]
+ },
+ "RegnId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n"
+ }
+ ]
+ },
+ "TaxTp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "TaxType\n\nType of tax payer.\n"
+ }
+ ]
+ },
+ "Authstn": {
+ "allOf": [
+ {
+ "title": "TaxAuthorisation1",
+ "description": "Details of an authorised tax paying party.\n",
+ "type": "object",
+ "properties": {
+ "Titl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ },
+ {
+ "description": "Authorisation\n\nDetails of the authorised tax paying party.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "TaxId": 123456789,
+ "RegnId": 123456789,
+ "TaxTp": "VAT",
+ "Authstn": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
+ }
+ }
},
- "Prtry": {
+ {
+ "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n"
+ }
+ ]
+ },
+ "AdmstnZone": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n"
}
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
- },
- {
- "required": [
- "Othr"
- ]
- }
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
- },
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "Agt": {
- "description": "Agent\nFinancial institution servicing an account for a party.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
+ "RefNb": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
"minLength": 1,
- "maxLength": 5,
+ "maxLength": 140,
"example": 12345
},
- "Prtry": {
+ {
+ "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n"
+ }
+ ]
+ },
+ "Mtd": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": 1.234567890123457e+34
+ },
+ {
+ "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "TtlTaxblBaseAmt": {
+ "allOf": [
{
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Cd"
- ]
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
},
{
+ "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlTaxAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
"required": [
- "Prtry"
- ]
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
+ ]
},
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ "Dt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "Date\n\nDate by which tax is due.\n"
+ }
+ ]
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "SeqNb": {
+ "allOf": [
+ {
+ "title": "Number",
"type": "string",
- "example": "ADDR"
+ "pattern": "^[\\d\\-\\.\\,]{1,18}$",
+ "example": 256
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "SequenceNumber\n\nSequential number of the tax report.\n"
+ }
+ ]
+ },
+ "Rcrd": {
+ "description": "Record\n\nDetails of the tax record.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "items": {
+ "title": "TaxRecord3",
+ "description": "Set of elements used to define the tax record.\n",
+ "type": "object",
+ "properties": {
+ "AddtlInf": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "AdditionalInformation\n\nFurther details of the tax record.\n"
+ }
+ ]
+ },
+ "CertId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n"
+ }
+ ]
+ },
+ "Ctgy": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n"
+ }
+ ]
+ },
+ "CtgyDtls": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CategoryDetails\n\nProvides further details of the category tax code.\n"
+ }
+ ]
+ },
+ "DbtrSts": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n"
+ }
+ ]
+ },
+ "FrmsCd": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n"
+ }
+ ]
+ },
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "TaxAmt": {
+ "allOf": [
+ {
+ "title": "TaxAmount3",
+ "description": "Information on the amount of the tax record.\n",
+ "type": "object",
+ "properties": {
+ "Rate": {
+ "allOf": [
+ {
+ "title": "PercentageRate",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$",
+ "example": 1234
+ },
+ {
+ "description": "Rate\n\nRate used to calculate the tax.\n"
+ }
+ ]
+ },
+ "TaxblBaseAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n"
+ }
+ ]
+ },
+ "TtlAmt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n"
+ }
+ ]
+ },
+ "Dtls": {
+ "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n",
+ "anyOf": [
+ {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ {
+ "items": {
+ "title": "TaxRecordDetails3",
+ "description": "Details on the tax period and amount.\n",
+ "type": "object",
+ "properties": {
+ "Prd": {
+ "allOf": [
+ {
+ "title": "TaxPeriod3",
+ "description": "Period of time details related to the tax payment.\n",
+ "type": "object",
+ "properties": {
+ "FrToDt": {
+ "allOf": [
+ {
+ "title": "DatePeriod2",
+ "description": "Range of time defined by a start date and an end date.\n",
+ "type": "object",
+ "properties": {
+ "FrDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "FromDate\nStart date of the range.\n"
+ }
+ ]
+ },
+ "ToDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "ToDate\nEnd date of the range.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "FrDt",
+ "ToDt"
+ ],
+ "example": {
+ "FrDt": "2022-01-01",
+ "ToDt": "2022-12-31"
+ }
+ },
+ {
+ "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "TaxRecordPeriod1Code",
+ "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n",
+ "type": "string",
+ "enum": [
+ "MM01",
+ "MM02",
+ "MM03",
+ "MM04",
+ "MM05",
+ "MM06",
+ "MM07",
+ "MM08",
+ "MM09",
+ "MM10",
+ "MM11",
+ "MM12",
+ "QTR1",
+ "QTR2",
+ "QTR3",
+ "QTR4",
+ "HLF1",
+ "HLF2"
+ ],
+ "example": "HLF1"
+ },
+ {
+ "description": "Type\n\nIdentification of the period related to the tax payment.\n"
+ }
+ ]
+ },
+ "Yr": {
+ "allOf": [
+ {
+ "title": "ISOYear",
+ "description": "Year represented by YYYY (ISO 8601).\n",
+ "type": "string",
+ "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$",
+ "example": 2019
+ },
+ {
+ "description": "Year\n\nYear related to the tax payment.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ }
+ },
+ {
+ "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n"
+ }
+ ]
+ },
+ "Amt": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount",
+ "type": "object",
+ "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n",
+ "properties": {
+ "ActiveOrHistoricCurrencyAndAmount": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType",
+ "type": "string",
+ "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$",
+ "example": 123.45
+ },
+ {
+ "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.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ActiveOrHistoricCurrencyAndAmount",
+ "Ccy"
+ ],
+ "example": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ }
+ },
+ {
+ "description": "Amount\n\nUnderlying tax amount related to the specified period.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Amt"
+ ],
+ "example": {
+ "Prd": {
+ "Yr": 2020,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2020-01-01",
+ "ToDt": "2020-01-31"
+ }
+ },
+ "Amt": {
+ "Amt": 100,
+ "Ccy": "EUR"
+ }
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Rate": 0,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 0
+ },
+ "Dtls": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
+ }
+ }
+ },
+ {
+ "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Type\n\nHigh level code to identify the type of tax details.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Tp": "VAT",
+ "Ctgy": "A",
+ "CtgyDtls": "Standard",
+ "DbtrSts": "Resident",
+ "CertId": 123456789,
+ "FrmsCd": 123456789,
+ "Prd": {
+ "Yr": 2019,
+ "Tp": "MM01",
+ "FrToDt": {
+ "FrDt": "2019-01-01",
+ "ToDt": "2019-12-31"
+ }
+ },
+ "TaxAmt": {
+ "Rate": 0.2,
+ "TaxblBaseAmt": {
+ "Ccy": "EUR",
+ "Amt": 1000
+ },
+ "TtlAmt": {
+ "Ccy": "EUR",
+ "Amt": 200
+ }
+ },
+ "AddtlInf": "VAT applicable"
+ }
+ },
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Cdtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
},
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Dbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
},
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "UltmtDbtr": {
+ "Titl": "Mr",
+ "Nm": "John Doe"
},
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "AdmstnZone": "CH",
+ "RefNb": 12345,
+ "Mtd": "A",
+ "TtlTaxblBaseAmt": {
+ "Ccy": "CHF",
+ "Amt": 1000
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ "TtlTaxAmt": {
+ "Ccy": "CHF",
+ "Amt": 100
},
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ "Dt": "2018-01-01",
+ "SeqNb": 1,
+ "Rcrd": {
+ "Tp": "T1",
+ "Ctry": "CH",
+ "Cd": "CHF",
+ "Amt": {
+ "Ccy": "CHF",
+ "Amt": 1000
+ },
+ "Inf": 12345
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
}
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
- "type": "object",
+ {
+ "description": "Tax\nProvides details on the tax.\n"
+ }
+ ]
+ },
+ "VrfctnOfTerms": {
+ "title": "CryptographicLockChoice",
+ "description": "Cryptographically signed terms\n",
+ "type": "object",
+ "oneOf": [
+ {
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
+ "IlpV4PrepPacket": {
+ "allOf": [
+ {
+ "title": "hexBinary",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "pattern": "^(0x|0X)?[a-fA-F0-9]+$",
+ "example": 4660
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n"
}
- },
- "oneOf": [
+ ]
+ }
+ },
+ "required": [
+ "IlpV4PrepPacket"
+ ]
+ },
+ {
+ "properties": {
+ "Sh256Sgntr": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Exact32HexBinaryText",
+ "description": "Specifies a hexadecimal string with a length of 32 characters.\n",
+ "type": "string",
+ "pattern": "^([0-9A-F][0-9A-F]){32}$",
+ "example": "1234567890ABCDEF1234567890ABCDEF"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "SHA-256 signature of the terms\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
- },
- "Issr": "BIC"
- }
+ "Sh256Sgntr"
+ ]
}
- },
+ ],
"example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ "IlpV4PrepPacket": "1234567890ABCDEF"
+ }
+ }
+ },
+ "required": [
+ "PmtId",
+ "IntrBkSttlmAmt",
+ "ChrgBr",
+ "Dbtr",
+ "DbtrAgt",
+ "CdtrAgt",
+ "Cdtr"
+ ],
+ "example": {
+ "PmtId": {
+ "InstrId": "INSTRID",
+ "EndToEndId": "ENDTOENDID"
+ },
+ "PmtTpInf": {
+ "LclInstrm": {
+ "Cd": "CHQB",
+ "Prtry": "PROPRIETARY"
+ },
+ "SeqTp": "SEQTP"
+ },
+ "IntrBkSttlmAmt": {
+ "ActiveCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "InstdAmt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "XchgRate": 123.45,
+ "ChrgBr": "SHAR",
+ "ChrgsInf": {
+ "Amt": {
+ "ActiveOrHistoricCurrencyAndAmount": 123.45,
+ "Ccy": "USD"
+ },
+ "Agt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
},
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
+ "FinInstnId": {
+ "BICFI": "BICFI"
}
+ },
+ "Tp": {
+ "Cd": "SHAR"
}
},
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "Dbtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
+ },
+ "DbtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "DbtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "CdtrAgt": {
+ "BrnchId": {
+ "Id": "BRANCHID"
+ },
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
+ },
+ "Cdtr": {
+ "Nm": "NAME",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "BldgNb": "BLDGNB",
+ "Ctry": "CTRY",
+ "TwnNm": "TWNNM",
+ "PstCd": "PSTCD",
+ "StrtNm": "STRTNM"
+ }
+ },
+ "CdtrAcct": {
+ "Id": {
+ "IBAN": "IBAN"
+ }
+ },
+ "InstrForCdtrAgt": {
+ "Cd": "CODE"
+ },
+ "InstrForNxtAgt": {
+ "Cd": "CODE"
+ },
+ "Purp": {
+ "Cd": "CASH"
+ },
+ "RgltryRptg": {
+ "Dbtr": true,
+ "Cdtr": true
+ },
+ "Tax": "Cdtr"
+ }
+ },
+ {
+ "description": "Credit Transfer Transaction Information\nSet of elements providing information specific to the individual credit transfer(s).\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "GrpHdr",
+ "CdtTrfTxInf"
+ ],
+ "example": {
+ "GrpHdr": {
+ "MsgId": 123456789,
+ "CreDtTm": "2020-01-01T00:00:00Z",
+ "NbOfTxs": 1,
+ "CtrlSum": 100,
+ "InitgPty": {
+ "Nm": "Initiating Party Name",
+ "Id": {
+ "OrgId": {
+ "Othr": [
+ {
+ "Id": 123456789,
+ "SchmeNm": {
+ "Cd": "BBA",
+ "Prtry": "Party Identification Scheme Name"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "FwdgAgt": {
+ "FinInstnId": {
+ "BICFI": "BBBBBBBB"
+ }
+ }
+ }
+ }
+ },
+ "UUIDv4Identifier": {
+ "title": "UUIDv4Identifier",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
+ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e"
+ },
+ "VerificationReason1Choice": {
+ "title": "VerificationReason1Choice",
+ "type": "object",
+ "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalVerificationReason1Code",
+ "description": "Specifies the external verification reason code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "AGNT"
+ }
+ },
+ "VerificationReport4": {
+ "title": "VerificationReport4",
+ "type": "object",
+ "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.",
+ "properties": {
+ "OrgnlId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n"
+ }
+ ]
+ },
+ "Vrfctn": {
+ "allOf": [
+ {
+ "title": "IdentificationVerificationIndicator",
+ "type": "boolean",
+ "example": true,
+ "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n"
+ },
+ {
+ "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n"
+ }
+ ]
+ },
+ "Rsn": {
+ "allOf": [
+ {
+ "title": "VerificationReason1Choice",
+ "type": "object",
+ "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalVerificationReason1Code",
+ "description": "Specifies the external verification reason code.",
"type": "string",
"minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "maxLength": 4,
+ "example": 1234
},
- "CtrySubDvsn": {
+ {
+ "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
"title": "Max35Text",
"description": "Specifies a character string with a maximum length of 35 characters.\n",
"type": "string",
@@ -116620,1769 +162465,4773 @@
"maxLength": 35,
"example": 1.234567890123457e+34
},
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
}
},
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
+ "required": [
+ "Prtry"
+ ]
}
- },
- "required": [
- "FinInstnId"
],
"example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
- },
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
- }
- }
- },
- "example": {
- "Pty": {
- "Id": {
- "OrgId": {
- "AnyBIC": {
- "BICFI": "BICFI"
- }
- }
- },
- "CtryOfRes": "FI"
- },
- "Acct": {
- "Id": {
- "IBAN": "FI2112345600000785"
+ "Cd": "AGNT"
}
},
- "Agt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
+ {
+ "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n"
}
- }
+ ]
},
- "UpdtdPtyAndAcctId": {
- "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n",
- "title": "IdentificationInformation4",
- "type": "object",
- "properties": {
- "Pty": {
- "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n",
- "title": "PartyIdentification135",
+ "OrgnlPtyAndAcctId": {
+ "allOf": [
+ {
+ "title": "IdentificationInformation4",
"type": "object",
+ "description": "Information that locates and identifies a specific party or account.\n",
"properties": {
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
- "description": "Choice of formats for the type of address.\n",
"properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
- "type": "object",
- "properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
"type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ },
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
"type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
}
- },
- "required": [
- "Id",
- "Issr"
- ],
- "example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
- }
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
]
},
- {
- "required": [
- "Prtry"
+ "CtctDtls": {
+ "allOf": [
+ {
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
+ },
+ {
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "ADDR"
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ },
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
}
},
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ {
+ "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n"
}
- },
- "example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- }
+ ]
},
- "Id": {
- "description": "Identification\nUnique and unambiguous way to identify an organisation.\n",
- "title": "Party38Choice",
- "type": "object",
- "properties": {
- "OrgId": {
- "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n",
- "title": "OrganisationIdentification29",
+ "Acct": {
+ "allOf": [
+ {
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "AnyBIC": {
- "description": "AnyBIC\nBusiness identification code of the organisation.\n",
- "title": "AnyBICDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "LEI": {
- "description": "LEI\nLegal entity identification as an alternate identification for a party.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Othr": {
- "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericOrganisationIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "OrganisationIdentificationSchemeName1Choice",
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
"type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalOrganisationIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
}
- },
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
+ ]
+ },
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
"oneOf": [
{
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
"required": [
"Cd"
]
},
- {
- "required": [
- "Prtry"
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
+ },
+ {
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
+ },
+ {
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
+ "type": "object",
+ "properties": {
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
]
}
+ },
+ "required": [
+ "Id"
],
"example": {
- "Cd": "BIC"
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
- }
+ ]
}
},
"example": {
- "AnyBIC": "BICFI",
- "LEI": "529900T8BM49AURSDO55",
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "BIC"
- },
- "Issr": "BIC"
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
}
}
},
- "PrvtId": {
- "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n",
- "title": "PersonIdentification13",
+ {
+ "description": "Account\nUnambiguous identification of the account of a party.\n"
+ }
+ ]
+ },
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "DtAndPlcOfBirth": {
- "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n",
- "title": "DateAndPlaceOfBirth1",
- "type": "object",
- "properties": {
- "BirthDt": {
- "description": "BirthDate\nDate on which a person is born.\n",
- "title": "ISODate",
- "type": "string",
- "format": "date",
- "example": "2013-03-07"
- },
- "PrvcOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CityOfBirth": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtryOfBirth": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- }
- },
- "required": [
- "BirthDt",
- "CityOfBirth",
- "CtryOfBirth"
- ],
- "example": {
- "BirthDt": "1970-01-01",
- "PrvcOfBirth": "ON",
- "CityOfBirth": "Ottawa",
- "CtryOfBirth": "CA"
- }
- },
- "Othr": {
- "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericPersonIdentification1",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "PersonIdentificationSchemeName1Choice",
+ "FinInstnId": {
+ "allOf": [
+ {
+ "title": "FinancialInstitutionIdentification18",
"type": "object",
+ "description": "Information used to identify a financial institution.\n",
"properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list\n",
- "title": "ExternalPersonIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
]
},
- {
- "required": [
- "Prtry"
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
]
}
- ],
+ },
+ "required": [],
"example": {
- "Cd": "CCPT"
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
}
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
}
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "DRLC"
+ ]
+ },
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
+ "type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
},
- "Issr": "BIC"
- }
+ {
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
+ }
+ ]
}
},
+ "required": [
+ "FinInstnId"
+ ],
"example": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
},
- "Othr": {
+ "BrnchId": {
"Id": 123,
- "SchmeNm": {
- "Cd": "CUST",
- "Prtry": 1
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
}
}
}
- }
- },
- "oneOf": [
- {
- "required": [
- "OrgId"
- ]
},
{
- "required": [
- "PrvtId"
- ]
- }
- ],
- "example": {
- "OrgId": {
- "AnyBIC": "BIC"
- },
- "PrvtId": {
- "DtAndPlcOfBirth": {
- "Dt": "2018-01-01",
- "CityOfBirth": "City"
- }
- }
- }
- },
- "CtryOfRes": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "CtctDtls": {
- "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n",
- "title": "Contact4",
- "type": "object",
- "properties": {
- "NmPrfx": {
- "description": "NamePrefix\nName prefix to be used before the name of the person.\n",
- "enum": [
- "DOCT",
- "MADM",
- "MISS",
- "MIST",
- "MIKS"
- ],
- "type": "string",
- "example": "DOCT"
- },
- "Nm": {
- "description": "Name\nName by which a party is known and which is usually used to identify that party.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PhneNb": {
- "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "MobNb": {
- "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "FaxNb": {
- "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n",
- "title": "PhoneNumber",
- "type": "string",
- "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
- },
- "EmailAdr": {
- "description": "EmailAddress\nAddress for electronic mail (e-mail).\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- },
- "EmailPurp": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "JobTitl": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Rspnsblty": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Othr": {
- "description": "Other\n: Contact details in another form.\n",
- "title": "OtherContact1",
- "type": "object",
- "properties": {
- "ChanlTp": {
- "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n",
- "title": "Max4Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Id": {
- "description": "Identifier\nCommunication value such as phone number or email address.\n",
- "title": "Max128Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "example": 12345
- }
- },
- "required": [
- "ChanlTp"
- ],
- "example": {
- "ChanlTp": "PHON",
- "Id": 1234567890
- }
- },
- "PrefrdMtd": {
- "description": "PreferredMethod\nPreferred method used to reach the contact.\n",
- "title": "PreferredContactMethod1Code",
- "type": "string",
- "enum": [
- "LETT",
- "MAIL",
- "PHON",
- "FAXX",
- "CELL"
- ],
- "example": "CELL"
+ "description": "Agent\nFinancial institution servicing an account for a party.\n"
}
- },
- "example": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
- }
+ ]
}
},
+ "required": [
+ "Pty"
+ ],
"example": {
- "Nm": "John Doe",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
- },
- "Id": {
- "OrgId": {
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Prtry": "DfspId"
+ "Pty": {
+ "Id": {
+ "OrgId": {
+ "AnyBIC": {
+ "BICFI": "BICFI"
}
}
+ },
+ "CtryOfRes": "FI"
+ },
+ "Acct": {
+ "Id": {
+ "IBAN": "FI2112345600000785"
}
},
- "CtryOfRes": "BE",
- "CtctDtls": {
- "NmPrfx": "Mr",
- "Nm": "John Doe",
- "PhneNb": "+123-123-321",
- "MobNb": "+123-123-321",
- "FaxNb": "+123-123-321",
- "EmailAdr": "example@example.com"
+ "Agt": {
+ "FinInstnId": {
+ "BICFI": "BICFI"
+ }
}
}
},
- "Acct": {
- "description": "Account\nUnambiguous identification of the account of a party.\n",
- "title": "CashAccount40",
+ {
+ "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n"
+ }
+ ]
+ },
+ "UpdtdPtyAndAcctId": {
+ "allOf": [
+ {
+ "title": "IdentificationInformation4",
"type": "object",
+ "description": "Information that locates and identifies a specific party or account.\n",
"properties": {
- "Id": {
- "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n",
- "title": "AccountIdentification4Choice",
- "type": "object",
- "properties": {
- "IBAN": {
- "description": "IBAN\nInternational 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.\n",
- "title": "IBAN2007Identifier",
- "type": "string",
- "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
- "example": "FR1420041010050500013M02606"
- },
- "Othr": {
- "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n",
- "title": "GenericAccountIdentification1",
+ "Pty": {
+ "allOf": [
+ {
+ "title": "PartyIdentification135",
+ "description": "Specifies the identification of a person or an organisation.\n",
"type": "object",
"properties": {
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
"Id": {
- "description": "Identification\nIdentification assigned by an institution.\n",
- "title": "Max34Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 34,
- "example": 1.2345678901234568e+33
+ "allOf": [
+ {
+ "title": "Party38Choice",
+ "description": "Nature or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "OrgId": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentification29",
+ "description": "Unique and unambiguous way to identify an organisation.\n",
+ "type": "object",
+ "properties": {
+ "AnyBIC": {
+ "allOf": [
+ {
+ "title": "AnyBICDec2014Identifier",
+ "type": "string",
+ "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "AnyBIC\nBusiness identification code of the organisation.\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identification as an alternate identification for a party.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericOrganisationIdentification1",
+ "type": "object",
+ "description": "Information that locates and identifies an organisation.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "OrganisationIdentificationSchemeName1Choice",
+ "description": "Choice of format for the organisation identification.\n",
+ "type": "object",
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalOrganisationIdentification1Code",
+ "description": "Specifies the external organisation identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ },
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {}
+ }
+ },
+ {
+ "properties": {
+ "Prtry": {}
+ }
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "AnyBIC": "BICFI",
+ "LEI": "529900T8BM49AURSDO55",
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "BIC"
+ },
+ "Issr": "BIC"
+ }
+ }
+ },
+ {
+ "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "OrgId"
+ ]
+ },
+ {
+ "properties": {
+ "PrvtId": {
+ "allOf": [
+ {
+ "title": "PersonIdentification13",
+ "description": "Unique and unambiguous way to identify a person.\n",
+ "type": "object",
+ "properties": {
+ "DtAndPlcOfBirth": {
+ "allOf": [
+ {
+ "title": "DateAndPlaceOfBirth1",
+ "description": "Details about date and place of birth of a person.\n",
+ "type": "object",
+ "properties": {
+ "BirthDt": {
+ "allOf": [
+ {
+ "title": "ISODate",
+ "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n",
+ "type": "string",
+ "format": "date",
+ "example": "2013-03-07"
+ },
+ {
+ "description": "BirthDate\nDate on which a person was born.\n"
+ }
+ ]
+ },
+ "PrvcOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "ProvinceOfBirth\nProvince where a person was born.\n"
+ }
+ ]
+ },
+ "CityOfBirth": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "CityOfBirth\nCity where a person was born.\n"
+ }
+ ]
+ },
+ "CtryOfBirth": {
+ "allOf": [
+ {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ {
+ "description": "CountryOfBirth\nCountry where a person was born.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "BirthDt",
+ "CityOfBirth",
+ "CtryOfBirth"
+ ],
+ "example": {
+ "BirthDt": "1970-01-01",
+ "PrvcOfBirth": "ON",
+ "CityOfBirth": "Ottawa",
+ "CtryOfBirth": "CA"
+ }
+ },
+ {
+ "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericPersonIdentification1",
+ "type": "object",
+ "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "PersonIdentificationSchemeName1Choice",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalPersonIdentification1Code",
+ "description": "Specifies the external person identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CCPT"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "DRLC"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "CUST",
+ "Prtry": 1
+ }
+ }
+ }
+ },
+ {
+ "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "PrvtId"
+ ]
+ }
+ ],
+ "example": {
+ "OrgId": {
+ "AnyBIC": "BIC"
+ },
+ "PrvtId": {
+ "DtAndPlcOfBirth": {
+ "Dt": "2018-01-01",
+ "CityOfBirth": "City"
+ }
+ }
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous way to identify an organisation.\n"
+ }
+ ]
},
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "AccountSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalAccountIdentification1Code",
+ "CtryOfRes": {
+ "allOf": [
+ {
+ "title": "CountryCode",
"type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ {
+ "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n"
}
- },
- "oneOf": [
+ ]
+ },
+ "CtctDtls": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "Contact4",
+ "description": "Specifies the details of the contact person.\n",
+ "type": "object",
+ "properties": {
+ "NmPrfx": {
+ "allOf": [
+ {
+ "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n",
+ "enum": [
+ "DOCT",
+ "MADM",
+ "MISS",
+ "MIST",
+ "MIKS"
+ ],
+ "type": "string",
+ "example": "DOCT"
+ },
+ {
+ "description": "NamePrefix\nName prefix to be used before the name of the person.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which a party is known and which is usually used to identify that party.\n"
+ }
+ ]
+ },
+ "PhneNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "MobNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "FaxNb": {
+ "allOf": [
+ {
+ "title": "PhoneNumber",
+ "type": "string",
+ "description": "Double check this regex.\n",
+ "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
+ },
+ {
+ "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n"
+ }
+ ]
+ },
+ "EmailAdr": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "EmailAddress\nAddress for electronic mail (e-mail).\n"
+ }
+ ]
+ },
+ "EmailPurp": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "EmailPurpose\nPurpose for which an email address may be used.\n"
+ }
+ ]
+ },
+ "JobTitl": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "JobTitle\nTitle of the function.\n"
+ }
+ ]
+ },
+ "Rspnsblty": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Responsibility\nRole of a person in an organisation.\n"
+ }
+ ]
+ },
+ "Dept": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ {
+ "description": "Department\nIdentification of a division of a large organisation or building.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "OtherContact1",
+ "description": "Communication device number or electronic address used for communication.\n",
+ "type": "object",
+ "properties": {
+ "ChanlTp": {
+ "allOf": [
+ {
+ "title": "Max4Text",
+ "description": "Specifies a character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n"
+ }
+ ]
+ },
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max128Text",
+ "description": "Specifies a character string with a maximum length of 128 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "example": 12345
+ },
+ {
+ "description": "Identifier\nCommunication value such as phone number or email address.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ChanlTp"
+ ],
+ "example": {
+ "ChanlTp": "PHON",
+ "Id": 1234567890
+ }
+ },
+ {
+ "description": "Other\nContact details in another form.\n"
+ }
+ ]
+ },
+ "PrefrdMtd": {
+ "allOf": [
+ {
+ "title": "PreferredContactMethod1Code",
+ "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n",
+ "type": "string",
+ "enum": [
+ "LETT",
+ "MAIL",
+ "PHON",
+ "FAXX",
+ "CELL"
+ ],
+ "example": "CELL"
+ },
+ {
+ "description": "PreferredMethod\nPreferred method used to reach the contact.\n"
+ }
+ ]
+ }
+ },
+ "example": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n"
}
- ],
- "example": {
- "Cd": 1111
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ ]
}
},
"required": [
"Id"
],
"example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ "Nm": "John Doe",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
},
- "Issr": "BIC"
+ "Id": {
+ "OrgId": {
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Prtry": "DfspId"
+ }
+ }
+ }
+ },
+ "CtryOfRes": "BE",
+ "CtctDtls": {
+ "NmPrfx": "Mr",
+ "Nm": "John Doe",
+ "PhneNb": "+123-123-321",
+ "MobNb": "+123-123-321",
+ "FaxNb": "+123-123-321",
+ "EmailAdr": "example@example.com"
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "IBAN"
- ]
},
{
- "required": [
- "Othr"
- ]
+ "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n"
}
- ],
- "example": {
- "IBAN": "BE71096123456769"
- }
+ ]
},
- "Tp": {
- "description": "Type\nSpecifies the nature, or use of the account.\n",
- "title": "CashAccountType2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nAccount type, in a coded form.\n",
- "title": "ExternalCashAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
- },
+ "Acct": {
+ "allOf": [
{
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CACC"
- }
- },
- "Ccy": {
- "description": "Currency\nDefinition: Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n",
- "title": "ActiveOrHistoricCurrencyCode",
- "type": "string",
- "pattern": "^[A-Z]{3,3}$",
- "example": "USD"
- },
- "Nm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "Prxy": {
- "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n",
- "title": "ProxyAccountIdentification1",
- "type": "object",
- "properties": {
- "Tp": {
- "description": "Type\n\nType of the proxy identification.\n",
- "title": "ProxyAccountType1Choice",
+ "title": "CashAccount40",
"type": "object",
+ "description": "Provides the details to identify an account.\n",
"properties": {
- "Cd": {
- "description": "Code\n\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalProxyAccountType1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
+ "Id": {
+ "allOf": [
+ {
+ "title": "AccountIdentification4Choice",
+ "type": "object",
+ "description": "Specifies the unique identification of an account as assigned by the account servicer.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "IBAN": {
+ "allOf": [
+ {
+ "title": "IBAN2007Identifier",
+ "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
+ "example": "FR1420041010050500013M02606"
+ },
+ {
+ "description": "IBAN\nInternational 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.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "IBAN"
+ ]
+ },
+ {
+ "properties": {
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericAccountIdentification1",
+ "type": "object",
+ "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max34Text",
+ "description": "Specifies a character string with a maximum length of 34 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 34,
+ "example": 1.2345678901234568e+33
+ },
+ {
+ "description": "Identification\nIdentification assigned by an institution.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "AccountSchemeName1Choice",
+ "type": "object",
+ "description": "Sets of elements to identify a name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalAccountIdentification1Code",
+ "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": 1111
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Othr"
+ ]
+ }
+ ],
+ "example": {
+ "IBAN": "BE71096123456769"
+ }
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n"
+ }
]
},
- {
- "required": [
- "Prtry"
- ]
- }
- ],
- "example": {
- "Cd": "CH03"
- }
- },
- "Id": {
- "description": "Identification\n\nIdentification used to indicate the account identification under another specified name.\n",
- "title": "Max2048Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 2048,
- "example": 2048
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Tp": {
- "Cd": "IBAN"
- },
- "Id": 123
- }
- }
- },
- "example": {
- "Id": {
- "IBAN": "BE71096123456769"
- },
- "Tp": {
- "Cd": "CACC"
- },
- "Ccy": "EUR",
- "Nm": "My account",
- "Prxy": {
- "Id": 12345
- }
- }
- },
- "Agt": {
- "description": "Agent\nFinancial institution servicing an account for a party.\n",
- "title": "BranchAndFinancialInstitutionIdentification6",
- "type": "object",
- "properties": {
- "FinInstnId": {
- "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
- "title": "FinancialInstitutionIdentification18",
- "type": "object",
- "properties": {
- "BICFI": {
- "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n",
- "title": "BICFIDec2014Identifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
- "example": "J5BMVH7D"
- },
- "ClrSysMmbId": {
- "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n",
- "title": "ClearingSystemMemberIdentification2",
- "type": "object",
- "properties": {
- "ClrSysId": {
- "description": "ClearingSystemIdentification.\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
- "title": "ClearingSystemIdentification2Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nIdentification of a member of a clearing system\n",
- "title": "ExternalClearingSystemIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 5,
- "example": 12345
+ "Tp": {
+ "allOf": [
+ {
+ "title": "CashAccountType2Choice",
+ "description": "Specifies the nature, or use of the account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalCashAccountType1Code",
+ "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nAccount type, in a coded form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nNature or use of the account in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CACC"
+ }
},
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
{
- "required": [
- "Cd"
- ]
+ "description": "Type\nSpecifies the nature, or use of the account.\n"
+ }
+ ]
+ },
+ "Ccy": {
+ "allOf": [
+ {
+ "title": "ActiveOrHistoricCurrencyCode",
+ "type": "string",
+ "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
+ "pattern": "^[A-Z]{3,3}$",
+ "example": "USD"
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n"
}
- ],
- "example": {
- "Cd": "CHQB"
- }
- },
- "MmbId": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "MmbId"
- ],
- "example": {
- "ClrSysId": {
- "Cd": "CHQB"
+ ]
},
- "MmbId": 123456789
- }
- },
- "LEI": {
- "description": "LEI\nLegal entity identifier of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
"type": "string",
- "example": "ADDR"
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
},
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ {
+ "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n"
+ }
+ ]
+ },
+ "Prxy": {
+ "allOf": [
+ {
+ "title": "ProxyAccountIdentification1",
+ "description": "Information related to a proxy identification of the account.\n",
"type": "object",
"properties": {
- "Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Tp": {
+ "allOf": [
+ {
+ "title": "ProxyAccountType1Choice",
+ "description": "Specifies the type of the proxy account.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalProxyAccountType1Code",
+ "description": "Specifies the external proxy account type code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nProxy account type, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProxy account type, in a proprietary form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "EMAIL"
+ }
+ },
+ {
+ "description": "Type\nType of the proxy identification.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max2048Text",
+ "description": "Specifies a character string with a maximum length of 2048 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 2048,
+ "example": 2048
+ },
+ {
+ "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n"
+ }
+ ]
}
},
"required": [
- "Id",
- "Issr"
+ "Id"
],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Tp": {
+ "Cd": "IBAN"
+ },
+ "Id": 123
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
"example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "Id": {
+ "IBAN": "BE71096123456769"
+ },
+ "Tp": {
+ "Cd": "CACC"
+ },
+ "Ccy": "EUR",
+ "Nm": "My account",
+ "Prxy": {
+ "Id": 12345
+ }
}
},
- "Othr": {
- "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n",
- "title": "GenericFinancialIdentification1",
+ {
+ "description": "Account\nUnambiguous identification of the account of a party.\n"
+ }
+ ]
+ },
+ "Agt": {
+ "allOf": [
+ {
+ "title": "BranchAndFinancialInstitutionIdentification6",
"type": "object",
+ "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n",
"properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "SchmeNm": {
- "description": "SchemeName\nName of the identification scheme.\n",
- "title": "FinancialIdentificationSchemeName1Choice",
- "type": "object",
- "properties": {
- "Cd": {
- "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n",
- "title": "ExternalFinancialInstitutionIdentification1Code",
- "type": "string",
- "minLength": 1,
- "maxLength": 4,
- "example": 1234
- },
- "Prtry": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "oneOf": [
+ "FinInstnId": {
+ "allOf": [
{
- "required": [
- "Cd"
- ]
+ "title": "FinancialInstitutionIdentification18",
+ "type": "object",
+ "description": "Information used to identify a financial institution.\n",
+ "properties": {
+ "BICFI": {
+ "allOf": [
+ {
+ "title": "BICFIDec2014Identifier",
+ "type": "string",
+ "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n",
+ "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
+ "example": "J5BMVH7D"
+ },
+ {
+ "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n"
+ }
+ ]
+ },
+ "ClrSysMmbId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemMemberIdentification2",
+ "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n",
+ "type": "object",
+ "properties": {
+ "ClrSysId": {
+ "allOf": [
+ {
+ "title": "ClearingSystemIdentification2Choice",
+ "description": "Specifies the clearing system identification.\n",
+ "type": "object",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalClearingSystemIdentification1Code",
+ "description": "Specifies the external clearing system identification code.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 5,
+ "example": 12345
+ },
+ {
+ "description": "Code\nClearing system identification code, as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nProprietary identification of the clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "CHIPS"
+ }
+ },
+ {
+ "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n"
+ }
+ ]
+ },
+ "MmbId": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "MemberIdentification\nIdentification of a member of a clearing system.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "MmbId"
+ ],
+ "example": {
+ "ClrSysId": {
+ "Cd": "CHQB"
+ },
+ "MmbId": 123456789
+ }
+ },
+ {
+ "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n"
+ }
+ ]
+ },
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "LEI\nLegal entity identifier of the financial institution.\n"
+ }
+ ]
+ },
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
+ },
+ "Othr": {
+ "allOf": [
+ {
+ "title": "GenericFinancialIdentification1",
+ "type": "object",
+ "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a person.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "FinancialIdentificationSchemeName1Choice",
+ "type": "object",
+ "description": "Specifies the name of the identification scheme.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "title": "ExternalFinancialInstitutionIdentification1Code",
+ "description": "Specifies the external financial institution identification code.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4,
+ "example": 1234
+ },
+ {
+ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Proprietary\nName of the identification scheme, in a free text form.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "BIC"
+ }
+ },
+ {
+ "description": "SchemeName\nName of the identification scheme.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id"
+ ],
+ "example": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": "IBAN"
+ },
+ "Issr": "BIC"
+ }
+ },
+ {
+ "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [],
+ "example": {
+ "BICFI": "J5BMVH7D",
+ "ClrSysMmbId": {
+ "ClrSysId": 1234,
+ "MmbId": 123
+ },
+ "LEI": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ },
+ "Othr": {
+ "Id": 123,
+ "SchmeNm": {
+ "Cd": 123,
+ "Prtry": 123
+ },
+ "Issr": 123
+ }
+ }
},
{
- "required": [
- "Prtry"
- ]
+ "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n"
}
- ],
- "example": {
- "Cd": "BIC"
- }
- },
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- }
- },
- "required": [
- "Id"
- ],
- "example": {
- "Id": 123,
- "SchmeNm": {
- "Cd": "IBAN"
+ ]
},
- "Issr": "BIC"
- }
- }
- },
- "example": {
- "BICFI": "J5BMVH7D",
- "ClrSysMmbId": {
- "ClrSysId": 1234,
- "MmbId": 123
- },
- "LEI": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- },
- "Othr": {
- "Id": 123,
- "SchmeNm": {
- "Cd": 123,
- "Prtry": 123
- },
- "Issr": 123
- }
- }
- },
- "BrnchId": {
- "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n",
- "title": "BranchData3",
- "type": "object",
- "properties": {
- "Id": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "LEI": {
- "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n",
- "title": "LEIIdentifier",
- "type": "string",
- "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
- "example": "529900T8BM49AURSDO55"
- },
- "Nm": {
- "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n",
- "title": "Max140Text",
- "type": "string",
- "minLength": 1,
- "maxLength": 140,
- "example": 12345
- },
- "PstlAdr": {
- "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n",
- "title": "PostalAddress24",
- "type": "object",
- "properties": {
- "AdrTp": {
- "title": "AddressType3Choice",
- "type": "object",
- "description": "Choice of formats for the type of address.\n",
- "properties": {
- "Cd": {
- "description": "Code\nType of address expressed as a code.\n",
- "enum": [
- "ADDR",
- "PBOX",
- "HOME",
- "BIZZ",
- "MLTO",
- "DLVY"
- ],
- "type": "string",
- "example": "ADDR"
- },
- "Prtry": {
- "description": "Proprietary\nType of address expressed as a proprietary code.\n",
- "title": "GenericIdentification30",
+ "BrnchId": {
+ "allOf": [
+ {
+ "title": "BranchData3",
"type": "object",
+ "description": "Information that locates and identifies a specific branch of a financial institution.\n",
"properties": {
"Id": {
- "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer\n",
- "title": "Exact4AlphaNumericText",
- "type": "string",
- "pattern": "^[a-zA-Z0-9]{4}$",
- "example": 1234
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n"
+ }
+ ]
},
- "Issr": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "LEI": {
+ "allOf": [
+ {
+ "title": "LEIIdentifier",
+ "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n",
+ "type": "string",
+ "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$",
+ "example": "529900T8BM49AURSDO55"
+ },
+ {
+ "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n"
+ }
+ ]
},
- "SchmeNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
+ "Nm": {
+ "allOf": [
+ {
+ "title": "Max140Text",
+ "description": "Specifies a character string with a maximum length of 140 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 140,
+ "example": 12345
+ },
+ {
+ "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n"
+ }
+ ]
+ },
+ "PstlAdr": {
+ "allOf": [
+ {
+ "title": "PostalAddress24",
+ "type": "object",
+ "description": "Information that locates and identifies a specific address, as defined by postal services.\n",
+ "properties": {
+ "AdrTp": {
+ "title": "AddressType3Choice",
+ "type": "object",
+ "description": "Choice of formats for the type of address.\n",
+ "oneOf": [
+ {
+ "properties": {
+ "Cd": {
+ "allOf": [
+ {
+ "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n",
+ "enum": [
+ "ADDR",
+ "PBOX",
+ "HOME",
+ "BIZZ",
+ "MLTO",
+ "DLVY"
+ ],
+ "type": "string",
+ "example": "ADDR"
+ },
+ {
+ "description": "Code\nType of address expressed as a code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Cd"
+ ]
+ },
+ {
+ "properties": {
+ "Prtry": {
+ "allOf": [
+ {
+ "title": "GenericIdentification30",
+ "type": "object",
+ "description": "Generic scheme identification for a party.\n",
+ "properties": {
+ "Id": {
+ "allOf": [
+ {
+ "title": "Exact4AlphaNumericText",
+ "description": "Specifies an alphanumeric string with a length of 4 characters.\n",
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]{4}$",
+ "example": 1234
+ },
+ {
+ "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n"
+ }
+ ]
+ },
+ "Issr": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "Issuer\nEntity that assigns the identification.\n"
+ }
+ ]
+ },
+ "SchmeNm": {
+ "allOf": [
+ {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ {
+ "description": "SchemeName\nShort textual description of the scheme.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Id",
+ "Issr"
+ ],
+ "example": {
+ "Id": 1234,
+ "Issr": "BIC",
+ "SchmeNm": "BICFI"
+ }
+ },
+ {
+ "description": "Proprietary\nType of address expressed as a proprietary code.\n"
+ }
+ ]
+ }
+ },
+ "required": [
+ "Prtry"
+ ]
+ }
+ ],
+ "example": {
+ "Cd": "ADDR"
+ }
+ },
+ "Dept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "SubDept": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "StrtNm": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "BldgNb": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "BldgNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Flr": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstBx": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "Room": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ },
+ "PstCd": {
+ "title": "Max16Text",
+ "description": "Specifies a character string with a maximum length of 16 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16,
+ "example": 1234567890123456
+ },
+ "TwnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "TwnLctnNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "DstrctNm": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "CtrySubDvsn": {
+ "title": "Max35Text",
+ "description": "Specifies a character string with a maximum length of 35 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 35,
+ "example": 1.234567890123457e+34
+ },
+ "Ctry": {
+ "title": "CountryCode",
+ "type": "string",
+ "pattern": "^[A-Z]{2,2}$",
+ "example": "US",
+ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
+ },
+ "AdrLine": {
+ "title": "Max70Text",
+ "description": "Specifies a character string with a maximum length of 70 characters.\n",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 70,
+ "example": 1.2345678901234567e+99
+ }
+ },
+ "example": {
+ "AdrTp": "ADDR",
+ "Dept": "Dept",
+ "SubDept": "SubDept",
+ "StrtNm": "StrtNm",
+ "BldgNb": "BldgNb",
+ "BldgNm": "BldgNm",
+ "Flr": "Flr",
+ "PstBx": "PstBx",
+ "Room": "Room",
+ "PstCd": "PstCd",
+ "TwnNm": "TwnNm",
+ "TwnLctnNm": "TwnLctnNm",
+ "DstrctNm": "DstrctNm",
+ "CtrySubDvsn": "CtrySubDvsn",
+ "Ctry": "Ctry",
+ "AdrLine": "AdrLine"
+ }
+ },
+ {
+ "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n"
+ }
+ ]
}
},
- "required": [
- "Id",
- "Issr"
- ],
"example": {
- "Id": 1234,
- "Issr": "BIC",
- "SchmeNm": "BICFI"
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
}
- }
- },
- "oneOf": [
- {
- "required": [
- "Cd"
- ]
},
{
- "required": [
- "Prtry"
- ]
+ "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n"
}
- ],
- "example": {
- "Cd": "ADDR"
- }
- },
- "Dept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "SubDept": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "StrtNm": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "BldgNb": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "BldgNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Flr": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstBx": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "Room": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
- },
- "PstCd": {
- "title": "Max16Text",
- "description": "Specifies a character string with a maximum length of 16 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 16,
- "example": 1234567890123456
- },
- "TwnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "TwnLctnNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "DstrctNm": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "CtrySubDvsn": {
- "title": "Max35Text",
- "description": "Specifies a character string with a maximum length of 35 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 35,
- "example": 1.234567890123457e+34
- },
- "Ctry": {
- "title": "CountryCode",
- "type": "string",
- "pattern": "^[A-Z]{2,2}$",
- "example": "US",
- "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
- },
- "AdrLine": {
- "title": "Max70Text",
- "description": "Specifies a character string with a maximum length of 70 characters.\n",
- "type": "string",
- "minLength": 1,
- "maxLength": 70,
- "example": 1.2345678901234567e+99
+ ]
}
},
+ "required": [
+ "FinInstnId"
+ ],
"example": {
- "AdrTp": "ADDR",
- "Dept": "Dept",
- "SubDept": "SubDept",
- "StrtNm": "StrtNm",
- "BldgNb": "BldgNb",
- "BldgNm": "BldgNm",
- "Flr": "Flr",
- "PstBx": "PstBx",
- "Room": "Room",
- "PstCd": "PstCd",
- "TwnNm": "TwnNm",
- "TwnLctnNm": "TwnLctnNm",
- "DstrctNm": "DstrctNm",
- "CtrySubDvsn": "CtrySubDvsn",
- "Ctry": "Ctry",
- "AdrLine": "AdrLine"
+ "FinInstnId": {
+ "BICFI": "J5BMVH7D"
+ },
+ "BrnchId": {
+ "Id": 123,
+ "Nm": "Name",
+ "PstlAdr": {
+ "AdrTp": "ADDR",
+ "Dept": "Department",
+ "SubDept": "Sub department",
+ "StrtNm": "Street name",
+ "BldgNb": "Building number",
+ "PstCd": "Post code",
+ "TwnNm": "Town name",
+ "CtrySubDvsn": "Country subdivision",
+ "Ctry": "Country",
+ "AdrLine": "Address line"
+ }
+ }
}
+ },
+ {
+ "description": "Agent\nFinancial institution servicing an account for a party.\n"
}
- },
- "example": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
- }
- }
+ ]
}
},
"required": [
- "FinInstnId"
+ "Pty"
],
"example": {
- "FinInstnId": {
- "BICFI": "J5BMVH7D"
+ "Pty": {
+ "Id": {
+ "OrgId": {
+ "AnyBIC": {
+ "BICFI": "BICFI"
+ }
+ }
+ },
+ "CtryOfRes": "FI"
},
- "BrnchId": {
- "Id": 123,
- "Nm": "Name",
- "PstlAdr": {
- "AdrTp": "ADDR",
- "Dept": "Department",
- "SubDept": "Sub department",
- "StrtNm": "Street name",
- "BldgNb": "Building number",
- "PstCd": "Post code",
- "TwnNm": "Town name",
- "CtrySubDvsn": "Country subdivision",
- "Ctry": "Country",
- "AdrLine": "Address line"
+ "Acct": {
+ "Id": {
+ "IBAN": "FI2112345600000785"
}
- }
- }
- }
- },
- "example": {
- "Pty": {
- "Id": {
- "OrgId": {
- "AnyBIC": {
+ },
+ "Agt": {
+ "FinInstnId": {
"BICFI": "BICFI"
}
}
- },
- "CtryOfRes": "FI"
- },
- "Acct": {
- "Id": {
- "IBAN": "FI2112345600000785"
}
},
- "Agt": {
- "FinInstnId": {
- "BICFI": "BICFI"
- }
+ {
+ "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n"
}
- }
+ ]
}
},
"required": [
"OrgnlId",
- "Vrfctn"
+ "Vrfctn",
+ "UpdtdPtyAndAcctId"
],
"example": {
"OrgnlId": 1.2345678901234568e+33,
diff --git a/src/fspiop/v2_0_ISO20022/openapi.ts b/src/fspiop/v2_0_ISO20022/openapi.ts
index f897a061..da48d1a8 100644
--- a/src/fspiop/v2_0_ISO20022/openapi.ts
+++ b/src/fspiop/v2_0_ISO20022/openapi.ts
@@ -519,15 +519,10 @@ export interface components {
* }
*/
AccountIdentification4Choice: {
- /** @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.
- * */
- IBAN?: components["schemas"]["IBAN2007Identifier"];
- /** @description Other
- * Unique identification of an account, as assigned by the account servicer, using an identification scheme.
- * */
- Othr?: components["schemas"]["GenericAccountIdentification1"];
- } & (unknown | unknown);
+ IBAN: components["schemas"]["IBAN2007Identifier"] & unknown;
+ } | {
+ Othr: components["schemas"]["GenericAccountIdentification1"] & unknown;
+ };
/**
* AccountSchemeName1Choice
* @description Sets of elements to identify a name of the identification scheme.
@@ -537,15 +532,10 @@ export interface components {
* }
*/
AccountSchemeName1Choice: {
- /** @description Code
- * Name of the identification scheme, in a coded form as published in an external list.
- * */
- Cd?: components["schemas"]["ExternalAccountIdentification1Code"];
- /** @description Proprietary
- * Name of the identification scheme, in a free text form.
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalAccountIdentification1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* ActiveCurrencyAndAmount
* @description A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
@@ -557,10 +547,7 @@ export interface components {
*/
ActiveCurrencyAndAmount: {
ActiveCurrencyAndAmount: components["schemas"]["ActiveCurrencyAndAmount_SimpleType"];
- /** @description Currency
- * Identification of the currency in which the account is held.
- * */
- Ccy: components["schemas"]["ActiveCurrencyCode"];
+ Ccy: components["schemas"]["ActiveCurrencyCode"] & unknown;
};
/**
* ActiveCurrencyAndAmount_SimpleType
@@ -592,11 +579,8 @@ export interface components {
* }
*/
ActiveOrHistoricCurrencyAndAmount: {
- ActiveOrHistoricCurrencyAndAmount: components["schemas"]["ActiveOrHistoricCurrencyAndAmount_SimpleType"];
- /** @description Currency
- * Identification of the currency in which the account is held.
- * */
- Ccy: components["schemas"]["ActiveOrHistoricCurrencyCode"];
+ ActiveOrHistoricCurrencyAndAmount: components["schemas"]["ActiveOrHistoricCurrencyAndAmount_SimpleType"] & unknown;
+ Ccy: components["schemas"]["ActiveOrHistoricCurrencyCode"] & unknown;
};
/**
* ActiveOrHistoricCurrencyAndAmount_SimpleType
@@ -612,8 +596,13 @@ export interface components {
ActiveOrHistoricCurrencyCode: string;
/**
* @description AddressType2Code
- *
* Specifies the type of address.
+ * ADDR Address
+ * PBOX PostBox
+ * HOME Home
+ * BIZZ Business
+ * MLTO MailingTo
+ * DLVY Delivery
*
* @example ADDR
* @enum {string}
@@ -628,15 +617,10 @@ export interface components {
* }
*/
AddressType3Choice: {
- /** @description Code
- * Type of address expressed as a code.
- * */
- Cd?: components["schemas"]["AddressType2Code"];
- /** @description Proprietary
- * Type of address expressed as a proprietary code.
- * */
- Prtry?: components["schemas"]["GenericIdentification30"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["AddressType2Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["GenericIdentification30"] & unknown;
+ };
/**
* AnyBICDec2014Identifier
* @description AnyBICDec2014Identifier
@@ -692,15 +676,8 @@ export interface components {
* }
*/
BranchAndFinancialInstitutionIdentification6: {
- /** @description FinancialInstitutionIdentification
- * Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
- * */
- FinInstnId: components["schemas"]["FinancialInstitutionIdentification18"];
- /** @description BranchIdentification
- * 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.
- * */
- BrnchId?: components["schemas"]["BranchData3"];
+ FinInstnId: components["schemas"]["FinancialInstitutionIdentification18"] & unknown;
+ BrnchId?: components["schemas"]["BranchData3"] & unknown;
};
/**
* BranchAndFinancialInstitutionIdentification8
@@ -729,15 +706,8 @@ export interface components {
* }
*/
BranchAndFinancialInstitutionIdentification8: {
- /** @description FinancialInstitutionIdentification
- * Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- * */
- FinInstnId: components["schemas"]["FinancialInstitutionIdentification23"];
- /** @description BranchIdentification
- *
- * Identifies a specific branch of a financial institution.
- * */
- BrnchId?: components["schemas"]["BranchData5"];
+ FinInstnId: components["schemas"]["FinancialInstitutionIdentification23"] & unknown;
+ BrnchId?: components["schemas"]["BranchData5"] & unknown;
};
/**
* BranchData3
@@ -761,22 +731,10 @@ export interface components {
* }
*/
BranchData3: {
- /** @description Identification
- * Unique and unambiguous identification of a branch of a financial institution.
- * */
- Id?: components["schemas"]["Max35Text"];
- /** @description Legal Entity Identifier
- * Legal entity identification for the branch of the financial institution.
- * */
- LEI?: components["schemas"]["LEIIdentifier"];
- /** @description Name
- * Name by which an agent is known and which is usually used to identify that agent.
- * */
- Nm?: components["schemas"]["Max140Text"];
- /** @description Postal Address
- * Information that locates and identifies a specific address, as defined by postal services.
- * */
- PstlAdr?: components["schemas"]["PostalAddress24"];
+ Id?: components["schemas"]["Max35Text"] & unknown;
+ LEI?: components["schemas"]["LEIIdentifier"] & unknown;
+ Nm?: components["schemas"]["Max140Text"] & unknown;
+ PstlAdr?: components["schemas"]["PostalAddress24"] & unknown;
};
/**
* BranchData5
@@ -791,32 +749,15 @@ export interface components {
* "Dept": "Department",
* "SubDept": "Sub department",
* "StrtNm": "Street name",
- * "BldgNb": "Building number",
- * "PstCd": "Post code",
- * "TwnNm": "Town name",
- * "CtrySubDvsn": "Country subdivision",
- * "Ctry": "Country",
- * "AdrLine": "Address line"
+ * "BldgNb": "Building number"
* }
* }
*/
BranchData5: {
- /** @description Identification
- * Unique and unambiguous identification of a branch of a financial institution.
- * */
- Id?: components["schemas"]["Max35Text"];
- /** @description LEI
- * Legal entity identification for the branch of the financial institution.
- * */
- LEI?: components["schemas"]["LEIIdentifier"];
- /** @description Name
- * Name by which an agent is known and which is usually used to identify that agent.
- * */
- Nm?: components["schemas"]["Max140Text"];
- /** @description PostalAddress
- * Information that locates and identifies a specific address, as defined by postal services.
- * */
- PstlAdr?: components["schemas"]["PostalAddress27"];
+ Id?: components["schemas"]["Max35Text"] & unknown;
+ LEI?: components["schemas"]["LEIIdentifier"] & unknown;
+ Nm?: components["schemas"]["Max140Text"] & unknown;
+ PstlAdr?: components["schemas"]["PostalAddress27"] & unknown;
};
/**
* CashAccount40
@@ -837,28 +778,11 @@ export interface components {
* }
*/
CashAccount40: {
- /** @description Identification
- * Unique and unambiguous identification for the account between the account owner and the account servicer.
- * */
- Id?: components["schemas"]["AccountIdentification4Choice"];
- /** @description Type
- * Specifies the nature, or use of the account.
- * */
- Tp?: components["schemas"]["CashAccountType2Choice"];
- /** @description Currency
- * Definition: Identification of the currency in which the account is held.
- * Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
- * */
- Ccy?: components["schemas"]["ActiveOrHistoricCurrencyCode"];
- /** @description Name
- * Definition: Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.
- * Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.
- * */
- Nm?: components["schemas"]["Max70Text"];
- /** @description Proxy
- * Specifies an alternate assumed name for the identification of the account.
- * */
- Prxy?: components["schemas"]["ProxyAccountIdentification1"];
+ Id?: components["schemas"]["AccountIdentification4Choice"] & unknown;
+ Tp?: components["schemas"]["CashAccountType2Choice"] & unknown;
+ Ccy?: components["schemas"]["ActiveOrHistoricCurrencyCode"] & unknown;
+ Nm?: components["schemas"]["Max70Text"] & unknown;
+ Prxy?: components["schemas"]["ProxyAccountIdentification1"] & unknown;
};
/**
* CashAccountType2Choice
@@ -869,15 +793,10 @@ export interface components {
* }
*/
CashAccountType2Choice: {
- /** @description Code
- * Account type, in a coded form.
- * */
- Cd?: components["schemas"]["ExternalCashAccountType1Code"];
- /** @description Proprietary
- * Nature or use of the account in a proprietary form.
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalCashAccountType1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* CategoryPurpose1Choice
* @description Contains details about high level purpose of the mandate based on a set of pre-defined categories.
@@ -887,22 +806,23 @@ export interface components {
* }
*/
CategoryPurpose1Choice: {
- /** @description Code
- * Category purpose, as published in an external category purpose code list.
- * */
- Cd?: components["schemas"]["ExternalCategoryPurpose1Code"];
- /** @description Proprietary
- * Category purpose, in a proprietary form.
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalCategoryPurpose1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* ChargeBearerType1Code
- * @description Specifies which party(ies) will pay charges due for processing of the instruction.
- * DEBT BorneByDebtor All transaction charges are to be borne by the debtor.
- * CRED BorneByCreditor All transaction charges are to be borne by the creditor.
- * SHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver
- * SLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level.
+ * @description Specifies which party(ies) will pay charges due for processing of the
+ * instruction.
+ *
+ * DEBT: BorneByDebtor All transaction charges are to be borne by the debtor.
+ * CRED: BorneByCreditor All transaction charges are to be borne by the creditor.
+ * SHAR: Shared In a credit transfer context, means that transaction charges on
+ * the sender side are to be borne by the debtor, transaction charges on the receiver side are to
+ * be borne by the creditor. In a direct debit context, means that transaction charges on the sender side
+ * are to be borne by the creditor, transaction charges on the receiver
+ * SLEV : FollowingServiceLevel Charges are to be applied following the rules
+ * agreed in the service level.
*
* @example DEBT
* @enum {string}
@@ -918,15 +838,10 @@ export interface components {
* }
*/
ChargeType3Choice: {
- /** @description Code
- * Charge type, in a coded form.
- * */
- Cd?: components["schemas"]["ExternalChargeType1Code"];
- /** @description Proprietary
- * Type of charge in a proprietary form, as defined by the issuer.
- * */
- Prtry?: components["schemas"]["GenericIdentification3"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalChargeType1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["GenericIdentification3"] & unknown;
+ };
/**
* Charges16
* @description NOTE: Unsure on description.
@@ -952,28 +867,19 @@ export interface components {
* }
*/
Charges16: {
- /** @description Amount
- *
- * Transaction charges to be paid by the charge bearer.
- * */
- Amt: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
- /** @description Agent
- * Agent that takes the transaction charges or to which the transaction charges are due.
- * */
- Agt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
- /** @description Type
- *
- * Defines the type of charges.
- * */
- Tp?: components["schemas"]["ChargeType3Choice"];
+ Amt: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown;
+ Agt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown;
+ Tp?: components["schemas"]["ChargeType3Choice"] & unknown;
};
/**
* ClearingChannel2Code
- * @description Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.
- * RTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.
- * RTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.
- * MPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.
- * BOOK BookTransfer Payment through internal book transfer.
+ * @description Specifies the clearing channel for the routing of the transaction, as part of
+ * the payment type identification.
+ *
+ * RTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.
+ * RTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.
+ * MPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.
+ * BOOK: BookTransfer Payment through internal book transfer.
*
* @example RTGS
* @enum {string}
@@ -981,22 +887,17 @@ export interface components {
ClearingChannel2Code: "RTGS" | "RTNS" | "MPNS" | "BOOK";
/**
* ClearingSystemIdentification2Choice
- * @description Choice of a clearing system identifier.
+ * @description Specifies the clearing system identification.
*
* @example {
- * "Cd": "CHQB"
+ * "Cd": "CHIPS"
* }
*/
ClearingSystemIdentification2Choice: {
- /** @description Code
- * Identification of a member of a clearing system
- * */
- Cd?: components["schemas"]["ExternalClearingSystemIdentification1Code"];
- /** @description Proprietary
- * Identification code for a clearing system, that has not yet been identified in the list of clearing systems.
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalClearingSystemIdentification1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* ClearingSystemMemberIdentification2
* @description Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
@@ -1009,14 +910,8 @@ export interface components {
* }
*/
ClearingSystemMemberIdentification2: {
- /** @description ClearingSystemIdentification.
- * Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
- * */
- ClrSysId?: components["schemas"]["ClearingSystemIdentification2Choice"];
- /** @description MemberIdentification.
- * Identification of a member of a clearing system.
- * */
- MmbId: components["schemas"]["Max35Text"];
+ ClrSysId?: components["schemas"]["ClearingSystemIdentification2Choice"] & unknown;
+ MmbId: components["schemas"]["Max35Text"] & unknown;
};
/**
* Contact13
@@ -1033,58 +928,19 @@ export interface components {
* }
*/
Contact13: {
- /** @description NamePrefix
- * Specifies the terms used to formally address a person.
- * */
- NmPrfx?: components["schemas"]["NamePrefix2Code"];
- /** @description Name
- * Name by which a party is known and which is usually used to identify that party.
- * */
- Nm?: components["schemas"]["Max140Text"];
- /** @description PhoneNumber
- * Collection of information that identifies a phone number, as defined by telecom services.
- * */
- PhneNb?: components["schemas"]["PhoneNumber"];
- /** @description MobilePhoneNumber
- * Collection of information that identifies a mobile phone number, as defined by telecom services.
- * */
- MobNb?: components["schemas"]["PhoneNumber"];
- /** @description FaxNumber
- * Collection of information that identifies a fax number, as defined by telecom services.
- * */
- FaxNb?: components["schemas"]["PhoneNumber"];
- /** @description URLAddress
- * Address for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.
- * */
- URLAdr?: components["schemas"]["Max2048Text"];
- /** @description EmailAddress
- * Address for electronic mail (e-mail).
- * */
- EmailAdr?: components["schemas"]["Max256Text"];
- /** @description EmailPurpose
- * Purpose for which an email address may be used.
- * */
- EmailPurp?: components["schemas"]["Max35Text"];
- /** @description JobTitle
- * Title of the function.
- * */
- JobTitl?: components["schemas"]["Max35Text"];
- /** @description Responsibility
- * Role of a person in an organisation.
- * */
- Rspnsblty?: components["schemas"]["Max35Text"];
- /** @description Department
- * Identification of a division of a large organisation or building.
- * */
- Dept?: components["schemas"]["Max70Text"];
- /** @description OtherContact
- * Contact details in another form.
- * */
- Othr?: components["schemas"]["OtherContact1"];
- /** @description PreferredContactMethod
- * Preferred method used to reach the contact.
- * */
- PrefrdMtd?: components["schemas"]["PreferredContactMethod2Code"];
+ NmPrfx?: components["schemas"]["NamePrefix2Code"] & unknown;
+ Nm?: components["schemas"]["Max140Text"] & unknown;
+ PhneNb?: components["schemas"]["PhoneNumber"] & unknown;
+ MobNb?: components["schemas"]["PhoneNumber"] & unknown;
+ FaxNb?: components["schemas"]["PhoneNumber"] & unknown;
+ URLAdr?: components["schemas"]["Max2048Text"] & unknown;
+ EmailAdr?: components["schemas"]["Max256Text"] & unknown;
+ EmailPurp?: components["schemas"]["Max35Text"] & unknown;
+ JobTitl?: components["schemas"]["Max35Text"] & unknown;
+ Rspnsblty?: components["schemas"]["Max35Text"] & unknown;
+ Dept?: components["schemas"]["Max70Text"] & unknown;
+ Othr?: components["schemas"]["OtherContact1"] & unknown;
+ PrefrdMtd?: components["schemas"]["PreferredContactMethod2Code"] & unknown;
};
/**
* Contact4
@@ -1100,54 +956,18 @@ export interface components {
* }
*/
Contact4: {
- /** @description NamePrefix
- * Name prefix to be used before the name of the person.
- * */
- NmPrfx?: components["schemas"]["NamePrefix2Code"];
- /** @description Name
- * Name by which a party is known and which is usually used to identify that party.
- * */
- Nm?: components["schemas"]["Max140Text"];
- /** @description PhoneNumber
- * Collection of information that identifies a phone number, as defined by telecom services.
- * */
- PhneNb?: components["schemas"]["PhoneNumber"];
- /** @description MobilePhoneNumber
- * Collection of information that identifies a mobile phone number, as defined by telecom services.
- * */
- MobNb?: components["schemas"]["PhoneNumber"];
- /** @description FaxNumber
- * Collection of information that identifies a fax number, as defined by telecom services.
- * */
- FaxNb?: components["schemas"]["PhoneNumber"];
- /** @description EmailAddress
- * Address for electronic mail (e-mail).
- * */
- EmailAdr?: components["schemas"]["Max2048Text"];
- /** @description EmailPurpose
- * Purpose for which an email address may be used.
- * */
- EmailPurp?: components["schemas"]["Max35Text"];
- /** @description JobTitle
- * Title of the function.
- * */
- JobTitl?: components["schemas"]["Max35Text"];
- /** @description Responsibility
- * Role of a person in an organisation.
- * */
- Rspnsblty?: components["schemas"]["Max35Text"];
- /** @description Department
- * Identification of a division of a large organisation or building.
- * */
- Dept?: components["schemas"]["Max70Text"];
- /** @description Other
- * : Contact details in another form.
- * */
- Othr?: components["schemas"]["OtherContact1"];
- /** @description PreferredMethod
- * Preferred method used to reach the contact.
- * */
- PrefrdMtd?: components["schemas"]["PreferredContactMethod1Code"];
+ NmPrfx?: components["schemas"]["NamePrefix2Code"] & unknown;
+ Nm?: components["schemas"]["Max140Text"] & unknown;
+ PhneNb?: components["schemas"]["PhoneNumber"] & unknown;
+ MobNb?: components["schemas"]["PhoneNumber"] & unknown;
+ FaxNb?: components["schemas"]["PhoneNumber"] & unknown;
+ EmailAdr?: components["schemas"]["Max2048Text"] & unknown;
+ EmailPurp?: components["schemas"]["Max35Text"] & unknown;
+ JobTitl?: components["schemas"]["Max35Text"] & unknown;
+ Rspnsblty?: components["schemas"]["Max35Text"] & unknown;
+ Dept?: components["schemas"]["Max70Text"] & unknown;
+ Othr?: components["schemas"]["OtherContact1"] & unknown;
+ PrefrdMtd?: components["schemas"]["PreferredContactMethod1Code"] & unknown;
};
/**
* CountryCode
@@ -1264,79 +1084,24 @@ export interface components {
* }
*/
CreditTransferTransaction67: {
- /** @description PaymentIdentification
- * Set of elements used to reference a payment instruction.
- * */
- PmtId: components["schemas"]["PaymentIdentification13"];
- /** @description PaymentTypeInformation
- *
- * Set of elements used to further specify the type of transaction.
- * */
- PmtTpInf?: components["schemas"]["PaymentTypeInformation28"];
- /** @description InterbankSettlementAmount
- * Amount of money moved between the instructing agent and the instructed agent.
- * */
- IntrBkSttlmAmt: components["schemas"]["ActiveCurrencyAndAmount"];
- /** @description InstructedAmount
- * 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.
- * */
- InstdAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
- /** @description ExchangeRate
- * Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.
- * */
- XchgRate?: components["schemas"]["BaseOneRate"];
- /** @description ChargeBearer
- * Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
- * */
+ PmtId: components["schemas"]["PaymentIdentification13"] & unknown;
+ PmtTpInf?: components["schemas"]["PaymentTypeInformation28"] & unknown;
+ IntrBkSttlmAmt: components["schemas"]["ActiveCurrencyAndAmount"] & unknown;
+ InstdAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown;
+ XchgRate?: components["schemas"]["BaseOneRate"] & unknown;
ChrgBr: components["schemas"]["ChargeBearerType1Code"];
- /** @description ChargesInformation
- * Provides information on the charges to be paid by the charge bearer(s) related to the payment transaction
- * */
- ChrgsInf?: components["schemas"]["Charges16"];
- /** @description Debtor
- * Party that owes an amount of money to the (ultimate) creditor.
- * */
- Dbtr: components["schemas"]["PartyIdentification272"];
- /** @description DebtorAccount
- * Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
- * */
- DbtrAcct?: components["schemas"]["CashAccount40"];
- /** @description DebtorAgent
- * Financial institution servicing an account for the debtor.
- * */
- DbtrAgt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
- /** @description CreditorAgent
- * Financial institution servicing an account for the creditor.
- * */
- CdtrAgt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
- /** @description Creditor
- * Party to which an amount of money is due.
- * */
- Cdtr: components["schemas"]["PartyIdentification272"];
- /** @description CreditorAccount
- * Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
- * */
- CdtrAcct?: components["schemas"]["CashAccount40"];
- /** @description InstructionForCreditorAgent
- * Set of elements used to provide information on the remittance advice.
- * */
- InstrForCdtrAgt?: components["schemas"]["InstructionForCreditorAgent3"];
- /** @description InstructionForNextAgent
- * Set of elements used to provide information on the remittance advice.
- * */
- InstrForNxtAgt?: components["schemas"]["InstructionForNextAgent1"];
- /** @description Purpose
- * Underlying reason for the payment transaction.
- * */
- Purp?: components["schemas"]["Purpose2Choice"];
- /** @description RegulatoryReporting
- * Information needed due to regulatory and statutory requirements.
- * */
- RgltryRptg?: components["schemas"]["RegulatoryReporting3"];
- /** @description Tax
- * Provides details on the tax.
- * */
- Tax?: components["schemas"]["TaxData1"];
+ ChrgsInf?: components["schemas"]["Charges16"] & unknown;
+ Dbtr: components["schemas"]["PartyIdentification272"] & unknown;
+ DbtrAcct?: components["schemas"]["CashAccount40"] & unknown;
+ DbtrAgt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown;
+ CdtrAgt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown;
+ Cdtr: components["schemas"]["PartyIdentification272"] & unknown;
+ CdtrAcct?: components["schemas"]["CashAccount40"] & unknown;
+ InstrForCdtrAgt?: components["schemas"]["InstructionForCreditorAgent3"] & unknown;
+ InstrForNxtAgt?: components["schemas"]["InstructionForNextAgent1"] & unknown;
+ Purp?: components["schemas"]["Purpose2Choice"] & unknown;
+ RgltryRptg?: components["schemas"]["RegulatoryReporting3"] & unknown;
+ Tax?: components["schemas"]["TaxData1"] & unknown;
VrfctnOfTerms?: components["schemas"]["CryptographicLockChoice"];
};
/**
@@ -1397,68 +1162,32 @@ export interface components {
* }
*/
CreditTransferTransaction68: {
- /** @description PaymentIdentification
- * Set of elements used to reference a payment instruction.
- * */
- PmtId: components["schemas"]["PaymentIdentification13"];
- /** @description PaymentTypeInformation
- *
- * Set of elements used to further specify the type of transaction.
- * */
- PmtTpInf?: components["schemas"]["PaymentTypeInformation28"];
- /** @description InterbankSettlementAmount
- * Amount of money moved between the instructing agent and the instructed agent.
- * */
- IntrBkSttlmAmt: components["schemas"]["ActiveCurrencyAndAmount"];
- /** @description Debtor
- * Party that owes an amount of money to the (ultimate) creditor.
- * */
- Dbtr: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
- /** @description DebtorAccount
- * Account used to process a payment.
- * */
- DbtrAcct?: components["schemas"]["CashAccount40"];
- /** @description DebtorAgent
- * Financial institution servicing an account for the debtor.
- * */
- DbtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
- /** @description CreditorAgent
- * Financial institution servicing an account for the creditor.
- * */
- CdtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
- /** @description Creditor
- * Party to which an amount of money is due.
- * */
- Cdtr: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
- /** @description CreditorAccount
- * Account to which a credit entry is made.
- * */
- CdtrAcct?: components["schemas"]["CashAccount40"];
- /** @description InstructionForCreditorAgent
- * Set of elements used to provide information on the remittance advice.
- * */
- InstrForCdtrAgt?: components["schemas"]["InstructionForCreditorAgent3"];
- /** @description Purpose
- * Underlying reason for the payment transaction.
- * */
- Purp?: components["schemas"]["Purpose2Choice"];
- /** @description VerificationOfTerms
- * Set of elements used to provide information on the underlying terms of the transaction.
- * */
- VrfctnOfTerms?: components["schemas"]["CryptographicLockChoice"];
+ PmtId: components["schemas"]["PaymentIdentification13"] & unknown;
+ PmtTpInf?: components["schemas"]["PaymentTypeInformation28"] & unknown;
+ IntrBkSttlmAmt: components["schemas"]["ActiveCurrencyAndAmount"] & unknown;
+ Dbtr: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown;
+ DbtrAcct?: components["schemas"]["CashAccount40"] & unknown;
+ DbtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown;
+ CdtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown;
+ Cdtr: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown;
+ CdtrAcct?: components["schemas"]["CashAccount40"] & unknown;
+ InstrForCdtrAgt?: components["schemas"]["InstructionForCreditorAgent3"] & unknown;
+ Purp?: components["schemas"]["Purpose2Choice"] & unknown;
+ VrfctnOfTerms?: components["schemas"]["CryptographicLockChoice"] & unknown;
};
/**
* CryptographicLockChoice
- * @description NOTE: Unsure on description.
+ * @description Cryptographically signed terms
*
* @example {
* "IlpV4PrepPacket": "1234567890ABCDEF"
* }
*/
CryptographicLockChoice: {
- IlpV4PrepPacket?: components["schemas"]["hexBinary"];
- Sh256Sgntr?: components["schemas"]["Exact32HexBinaryText"];
- } & (unknown | unknown);
+ IlpV4PrepPacket: components["schemas"]["hexBinary"] & unknown;
+ } | {
+ Sh256Sgntr: components["schemas"]["Exact32HexBinaryText"] & unknown;
+ };
/**
* DateAndPlaceOfBirth1
* @description Details about date and place of birth of a person.
@@ -1471,41 +1200,23 @@ export interface components {
* }
*/
DateAndPlaceOfBirth1: {
- /** @description BirthDate
- * Date on which a person is born.
- * */
- BirthDt: components["schemas"]["ISODate"];
- /** @description ProvinceOfBirth
- * Province where a person was born.
- * */
- PrvcOfBirth?: components["schemas"]["Max35Text"];
- /** @description CityOfBirth
- * City where a person was born.
- * */
- CityOfBirth: components["schemas"]["Max35Text"];
- /** @description CountryOfBirth
- * Country where a person was born.
- * */
- CtryOfBirth: components["schemas"]["CountryCode"];
+ BirthDt: components["schemas"]["ISODate"] & unknown;
+ PrvcOfBirth?: components["schemas"]["Max35Text"] & unknown;
+ CityOfBirth: components["schemas"]["Max35Text"] & unknown;
+ CtryOfBirth: components["schemas"]["CountryCode"] & unknown;
};
/**
* DatePeriod2
* @description Range of time defined by a start date and an end date.
*
* @example {
- * "FrDt": "2022-01-01T00:00:00.000Z",
- * "ToDt": "2022-12-31T23:59:59.999Z"
+ * "FrDt": "2022-01-01",
+ * "ToDt": "2022-12-31"
* }
*/
DatePeriod2: {
- /** @description FromDate
- * Start date of the range.
- * */
- FrDt: components["schemas"]["ISODate"];
- /** @description ToDate
- * End date of the range.
- * */
- ToDt: components["schemas"]["ISODate"];
+ FrDt: components["schemas"]["ISODate"] & unknown;
+ ToDt: components["schemas"]["ISODate"] & unknown;
};
/**
* ErrorCode
@@ -1570,36 +1281,6 @@ export interface components {
* "SttlmAcctSvcr": {
* "BICFI": 123
* }
- * },
- * "CdtTrfTxInf": {
- * "PmtId": {
- * "InstrId": 123,
- * "EndToEndId": 123
- * },
- * "PmtTpInf": {
- * "InstrPrty": "NORM"
- * },
- * "InstdAmt": {
- * "Amt": 123,
- * "Ccy": "EUR"
- * },
- * "ChrgBr": "SLEV",
- * "CdtrAgt": {
- * "FinInstnId": {
- * "BICFI": 123
- * }
- * },
- * "Cdtr": {
- * "Nm": "John Doe"
- * },
- * "CdtrAcct": {
- * "Id": {
- * "IBAN": 123
- * }
- * },
- * "RmtInf": {
- * "Ustrd": "Test"
- * }
* }
* },
* "CdtTrfTxInf": {
@@ -1635,12 +1316,8 @@ export interface components {
* }
*/
Execute_FIToFICustomerCreditTransferV13: {
- /** @description GroupHeader.
- * */
- GrpHdr: components["schemas"]["GroupHeader129"];
- /** @description CreditTransferTransactionInformation.
- * */
- CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"];
+ GrpHdr: components["schemas"]["GroupHeader129"] & unknown;
+ CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"] & unknown;
};
/**
* Extension
@@ -1692,87 +1369,101 @@ export interface components {
ExternalCategoryPurpose1Code: string;
/**
* ExternalChargeType1Code
+ * @description Specifies the type of charge applied to the transaction.
+ *
* @example 1234
*/
ExternalChargeType1Code: string;
/**
* ExternalClearingSystemIdentification1Code
+ * @description Specifies the external clearing system identification code.
+ *
* @example 12345
*/
ExternalClearingSystemIdentification1Code: string;
/**
* ExternalCreditorAgentInstruction1Code
+ * @description Specifies the instruction given by the creditor to the creditor agent.
* @example 1234
*/
ExternalCreditorAgentInstruction1Code: string;
/**
* ExternalFinancialInstitutionIdentification1Code
+ * @description Specifies the external financial institution identification code.
* @example 1234
*/
ExternalFinancialInstitutionIdentification1Code: string;
/**
* ExternalLocalInstrument1Code
+ * @description Specifies the external local instrument identification code.
* @example 12345
*/
ExternalLocalInstrument1Code: string;
/**
* ExternalOrganisationIdentification1Code
+ * @description Specifies the external organisation identification code.
* @example 1234
*/
ExternalOrganisationIdentification1Code: string;
/**
* ExternalPaymentTransactionStatus1Code
+ * @description Specifies the external payment transaction status code.
* @example 1234
*/
ExternalPaymentTransactionStatus1Code: string;
/**
* ExternalPersonIdentification1Code
+ * @description Specifies the external person identification code.
* @example 1234
*/
ExternalPersonIdentification1Code: string;
/**
* ExternalProxyAccountType1Code
+ * @description Specifies the external proxy account type code.
* @example 1234
*/
ExternalProxyAccountType1Code: string;
/**
* ExternalPurpose1Code
+ * @description Specifies the external purpose code.
* @example 1234
*/
ExternalPurpose1Code: string;
/**
* ExternalServiceLevel1Code
+ * @description Specifies the external service level code.
* @example 1234
*/
ExternalServiceLevel1Code: string;
/**
* ExternalStatusReason1Code
+ * @description Specifies the external status reason code.
* @example 1234
*/
ExternalStatusReason1Code: string;
/**
* ExternalVerificationReason1Code
+ * @description Specifies the external verification reason code.
* @example 1234
*/
ExternalVerificationReason1Code: string;
/**
* FinancialIdentificationSchemeName1Choice
+ * @description Specifies the name of the identification scheme.
+ *
* @example {
* "Cd": "BIC"
* }
*/
FinancialIdentificationSchemeName1Choice: {
- /** @description Code
- * Name of the identification scheme, in a coded form as published in an external list.
- * */
- Cd?: components["schemas"]["ExternalFinancialInstitutionIdentification1Code"];
- /** @description Proprietary
- * Name of the identification scheme, in a free text form.
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalFinancialInstitutionIdentification1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* FinancialInstitutionIdentification18
+ * @description Information used to identify a financial institution.
+ *
* @example {
* "BICFI": "J5BMVH7D",
* "ClrSysMmbId": {
@@ -1804,40 +1495,22 @@ export interface components {
* }
*/
FinancialInstitutionIdentification18: {
- /** @description BICFI
- * Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)"
- * */
- BICFI?: components["schemas"]["BICFIDec2014Identifier"];
- /** @description ClearingSystemMemberIdentification
- * Information used to identify a member within a clearing system
- * */
- ClrSysMmbId?: components["schemas"]["ClearingSystemMemberIdentification2"];
- /** @description LEI
- * Legal entity identifier of the financial institution.
- * */
- LEI?: components["schemas"]["LEIIdentifier"];
- /** @description Name
- * Name by which an agent is known and which is usually used to identify that agent
- * */
- Nm?: components["schemas"]["Max140Text"];
- /** @description PostalAddress
- * Information that locates and identifies a specific address, as defined by postal services.
- * */
- PstlAdr?: components["schemas"]["PostalAddress24"];
- /** @description Other
- * Unique identification of an agent, as assigned by an institution, using an identification scheme.
- * */
- Othr?: components["schemas"]["GenericFinancialIdentification1"];
+ BICFI?: components["schemas"]["BICFIDec2014Identifier"] & unknown;
+ ClrSysMmbId?: components["schemas"]["ClearingSystemMemberIdentification2"] & unknown;
+ LEI?: components["schemas"]["LEIIdentifier"] & unknown;
+ Nm?: components["schemas"]["Max140Text"] & unknown;
+ PstlAdr?: components["schemas"]["PostalAddress24"] & unknown;
+ Othr?: components["schemas"]["GenericFinancialIdentification1"] & unknown;
};
/**
* FinancialInstitutionIdentification23
+ * @description Information used to identify a financial institution.
+ *
* @example {
* "BICFI": "J5BMVH7D",
* "ClrSysMmbId": {
- * "ClrSysId": {
- * "Cd": "CHQB"
- * },
- * "MmbId": 123456789
+ * "ClrSysId": 1234,
+ * "MmbId": 123
* },
* "LEI": 123,
* "Nm": "Name",
@@ -1856,40 +1529,26 @@ export interface components {
* "Othr": {
* "Id": 123,
* "SchmeNm": {
- * "Cd": "CHQB"
+ * "Cd": 123,
+ * "Prtry": 123
* },
* "Issr": 123
* }
* }
*/
FinancialInstitutionIdentification23: {
- /** @description BICFI
- * Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)"
- * */
- BICFI?: components["schemas"]["BICFIDec2014Identifier"];
- /** @description ClearingSystemMemberIdentification
- * Information used to identify a member within a clearing system
- * */
- ClrSysMmbId?: components["schemas"]["ClearingSystemMemberIdentification2"];
- /** @description LEI
- * Legal entity identifier of the financial institution.
- * */
- LEI?: components["schemas"]["LEIIdentifier"];
- /** @description Name
- * Name by which an agent is known and which is usually used to identify that agent
- * */
- Nm?: components["schemas"]["Max140Text"];
- /** @description PostalAddress
- * Information that locates and identifies a specific address, as defined by postal services.
- * */
- PstlAdr?: components["schemas"]["PostalAddress27"];
- /** @description Other
- * Unique identification of an agent, as assigned by an institution, using an identification scheme.
- * */
- Othr?: components["schemas"]["GenericFinancialIdentification1"];
+ BICFI?: components["schemas"]["BICFIDec2014Identifier"] & unknown;
+ ClrSysMmbId?: components["schemas"]["ClearingSystemMemberIdentification2"] & unknown;
+ LEI?: components["schemas"]["LEIIdentifier"] & unknown;
+ Nm?: components["schemas"]["Max140Text"] & unknown;
+ PstlAdr?: components["schemas"]["PostalAddress24"] & unknown;
+ Othr?: components["schemas"]["GenericFinancialIdentification1"] & unknown;
};
/**
* FxRequest_FICreditTransferProposal
+ * @description FxRequest_FICreditTransferProposal
+ * A group of elements providing information specific to the individual credit transfer(s) included in the message.
+ *
* @example {
* "GrpHdr": {
* "MsgId": 12345,
@@ -2003,13 +1662,13 @@ export interface components {
* }
*/
FxRequest_FICreditTransferProposal: {
- /** @description GroupHeader
- * Set of characteristics shared by all individual transactions included in the message.
- * */
- GrpHdr: components["schemas"]["GroupHeader113"];
+ GrpHdr: components["schemas"]["GroupHeader113"] & unknown;
};
/**
* FxResponse_FICreditTransferConfirmation
+ * @description FxResponse_FICreditTransferConfirmation
+ * The FxResponse_FICreditTransferConfirmation message is sent by the FSP to the Payer FSP to confirm the successful processing of the credit transfer.
+ *
* @example {
* "GrpHdr": {
* "MsgId": "20191122-123456",
@@ -2115,17 +1774,13 @@ export interface components {
* }
*/
FxResponse_FICreditTransferConfirmation: {
- /** @description GroupHeader
- * Set of characteristics shared by all individual transactions included in the message.
- * */
- GrpHdr: components["schemas"]["GroupHeader113"];
- /** @description CreditTransferTransactionInformation
- * Set of elements providing information specific to the individual credit transfer(s).
- * */
- CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"];
+ GrpHdr: components["schemas"]["GroupHeader113"] & unknown;
+ CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"] & unknown;
};
/**
* Fxecute_FinancialInstitutionCreditTransferV12
+ * @description The Fxecute FinancialInstitutionCreditTransfer message is sent by the initiating party to the executing party to request the execution of a payment. It is used to request movement of funds from the debtor account to the creditor account. The message can carry multiple credit transfer instructions.
+ *
* @example {
* "GrpHdr": {
* "MsgId": 20191113001,
@@ -2200,17 +1855,14 @@ export interface components {
* }
*/
Fxecute_FinancialInstitutionCreditTransferV12: {
- /** @description GroupHeader.
- * Set of characteristics shared by all individual transactions included in the message.
- * */
- GrpHdr: components["schemas"]["GroupHeader129"];
- /** @description CreditTransferTransactionInformation.
- * Set of elements providing information specific to the individual credit transfer(s).
- * */
- CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"];
+ GrpHdr: components["schemas"]["GroupHeader129"] & unknown;
+ CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"] & unknown;
};
/**
* GenericAccountIdentification1
+ * @description GenericAccountIdentification
+ * Unique and unambiguous identification of an account, as assigned by the account servicer.
+ *
* @example {
* "Id": 123,
* "SchmeNm": {
@@ -2220,21 +1872,15 @@ export interface components {
* }
*/
GenericAccountIdentification1: {
- /** @description Identification
- * Identification assigned by an institution.
- * */
- Id: components["schemas"]["Max34Text"];
- /** @description SchemeName
- * Name of the identification scheme.
- * */
- SchmeNm?: components["schemas"]["AccountSchemeName1Choice"];
- /** @description Issuer
- * Entity that assigns the identification.
- * */
- Issr?: components["schemas"]["Max35Text"];
+ Id: components["schemas"]["Max34Text"] & unknown;
+ SchmeNm?: components["schemas"]["AccountSchemeName1Choice"] & unknown;
+ Issr?: components["schemas"]["Max35Text"] & unknown;
};
/**
* GenericFinancialIdentification1
+ * @description GenericFinancialIdentification
+ * Unique and unambiguous identification of a person, which is used to refer to a person in a financial context.
+ *
* @example {
* "Id": 123,
* "SchmeNm": {
@@ -2244,38 +1890,27 @@ export interface components {
* }
*/
GenericFinancialIdentification1: {
- /** @description Identification
- * Unique and unambiguous identification of a person.
- * */
- Id: components["schemas"]["Max35Text"];
- /** @description SchemeName
- * Name of the identification scheme.
- * */
- SchmeNm?: components["schemas"]["FinancialIdentificationSchemeName1Choice"];
- /** @description Issuer
- * Entity that assigns the identification.
- * */
- Issr?: components["schemas"]["Max35Text"];
+ Id: components["schemas"]["Max35Text"] & unknown;
+ SchmeNm?: components["schemas"]["FinancialIdentificationSchemeName1Choice"] & unknown;
+ Issr?: components["schemas"]["Max35Text"] & unknown;
};
/**
* GenericIdentification3
+ * @description Generic scheme identification for a party.
+ *
* @example {
* "Id": 123,
* "Issr": "BIC"
* }
*/
GenericIdentification3: {
- /** @description Identification
- * Name or number assigned by an entity to enable recognition of that entity, for example, account identifier.
- * */
- Id: components["schemas"]["Max35Text"];
- /** @description Issuer
- * Entity that assigns the identification.
- * */
- Issr?: components["schemas"]["Max35Text"];
+ Id: components["schemas"]["Max35Text"] & unknown;
+ Issr?: components["schemas"]["Max35Text"] & unknown;
};
/**
* GenericIdentification30
+ * @description Generic scheme identification for a party.
+ *
* @example {
* "Id": 1234,
* "Issr": "BIC",
@@ -2283,21 +1918,14 @@ export interface components {
* }
*/
GenericIdentification30: {
- /** @description Identification
- * Proprietary information, often a code, issued by the data source scheme issuer
- * */
- Id: components["schemas"]["Exact4AlphaNumericText"];
- /** @description Issuer
- * Entity that assigns the identification.
- * */
- Issr: components["schemas"]["Max35Text"];
- /** @description SchemeName
- * Short textual description of the scheme.
- * */
- SchmeNm?: components["schemas"]["Max35Text"];
+ Id: components["schemas"]["Exact4AlphaNumericText"] & unknown;
+ Issr: components["schemas"]["Max35Text"] & unknown;
+ SchmeNm?: components["schemas"]["Max35Text"] & unknown;
};
/**
* GenericOrganisationIdentification1
+ * @description Information that locates and identifies an organisation.
+ *
* @example {
* "Id": 123,
* "SchmeNm": {
@@ -2307,21 +1935,14 @@ export interface components {
* }
*/
GenericOrganisationIdentification1: {
- /** @description Identification
- * Identification assigned by an institution.
- * */
- Id: components["schemas"]["Max35Text"];
- /** @description SchemeName
- * Name of the identification scheme.
- * */
- SchmeNm?: components["schemas"]["OrganisationIdentificationSchemeName1Choice"];
- /** @description Issuer
- * Entity that assigns the identification.
- * */
- Issr?: components["schemas"]["Max35Text"];
+ Id: components["schemas"]["Max35Text"] & unknown;
+ SchmeNm?: components["schemas"]["OrganisationIdentificationSchemeName1Choice"] & unknown;
+ Issr?: components["schemas"]["Max35Text"] & unknown;
};
/**
* GenericOrganisationIdentification3
+ * @description Information related to an identification of an organisation.
+ *
* @example {
* "Id": 123,
* "SchmeNm": {
@@ -2331,20 +1952,15 @@ export interface components {
* }
*/
GenericOrganisationIdentification3: {
- /** @description Identification
- * Identification assigned by an institution.
- * */
- Id: components["schemas"]["Max256Text"];
- /** @description SchemeName
- * Name of the identification scheme. */
- SchmeNm?: components["schemas"]["OrganisationIdentificationSchemeName1Choice"];
- /** @description Issuer
- * Entity that assigns the identification.
- * */
- Issr?: components["schemas"]["Max35Text"];
+ Id: components["schemas"]["Max256Text"] & unknown;
+ SchmeNm?: components["schemas"]["OrganisationIdentificationSchemeName1Choice"] & unknown;
+ Issr?: components["schemas"]["Max35Text"] & unknown;
};
/**
* GenericPersonIdentification1
+ * @description GenericPersonIdentification1
+ * Information that locates and identifies a specific person.
+ *
* @example {
* "Id": 123,
* "SchmeNm": {
@@ -2354,21 +1970,13 @@ export interface components {
* }
*/
GenericPersonIdentification1: {
- /** @description Identification
- * Unique and unambiguous identification of a person.
- * */
- Id: components["schemas"]["Max35Text"];
- /** @description SchemeName
- * Name of the identification scheme.
- * */
- SchmeNm?: components["schemas"]["PersonIdentificationSchemeName1Choice"];
- /** @description Issuer
- * Entity that assigns the identification.
- * */
- Issr?: components["schemas"]["Max35Text"];
+ Id: components["schemas"]["Max35Text"] & unknown;
+ SchmeNm?: components["schemas"]["PersonIdentificationSchemeName1Choice"] & unknown;
+ Issr?: components["schemas"]["Max35Text"] & unknown;
};
/**
* GenericPersonIdentification2
+ * @description Identification of a person.
* @example {
* "Id": 123,
* "SchmeNm": {
@@ -2378,18 +1986,9 @@ export interface components {
* }
*/
GenericPersonIdentification2: {
- /** @description Identification
- * Unique and unambiguous identification of a person.
- * */
- Id: components["schemas"]["Max256Text"];
- /** @description SchemeName
- * Name of the identification scheme.
- * */
- SchmeNm?: components["schemas"]["PersonIdentificationSchemeName1Choice"];
- /** @description Issuer
- * Entity that assigns the identification.
- * */
- Issr?: components["schemas"]["Max35Text"];
+ Id: components["schemas"]["Max256Text"] & unknown;
+ SchmeNm?: components["schemas"]["PersonIdentificationSchemeName1Choice"] & unknown;
+ Issr?: components["schemas"]["Max35Text"] & unknown;
};
/**
* GetPartiesError_IdentificationVerificationReportV03
@@ -2460,18 +2059,9 @@ export interface components {
* }
*/
GetPartiesError_IdentificationVerificationReportV03: {
- /** @description Assignment
- * Information related to the identification assignment.
- * */
- Assgnmt: components["schemas"]["IdentificationAssignment3"];
- /** @description Report
- * Information concerning the verification of the identification data for which verification was requested.
- * */
- Rpt: components["schemas"]["VerificationReport4"];
- /** @description SupplementaryData
- * Additional information that cannot be captured in the structured elements and/or any other specific block.
- * */
- SplmtryData?: components["schemas"]["SupplementaryData1"];
+ Assgnmt: components["schemas"]["IdentificationAssignment3"] & unknown;
+ Rpt: components["schemas"]["VerificationReport4"] & unknown;
+ SplmtryData?: components["schemas"]["SupplementaryData1"] & unknown;
};
/**
* GetParties_IdentificationVerificationReportV03
@@ -2547,18 +2137,9 @@ export interface components {
* }
*/
GetParties_IdentificationVerificationReportV03: {
- /** @description Assignment
- * Identifies the identification assignment.
- * */
- Assgnmt: components["schemas"]["IdentificationAssignment3"];
- /** @description Report
- * Information concerning the verification of the identification data for which verification was requested.
- * */
- Rpt: components["schemas"]["VerificationReport4"];
- /** @description SupplementaryData
- * Additional information that cannot be captured in the structured elements and/or any other specific block.
- * */
- SplmtryData?: components["schemas"]["SupplementaryData1"];
+ Assgnmt: components["schemas"]["IdentificationAssignment3"] & unknown;
+ Rpt: components["schemas"]["VerificationReport4"] & unknown;
+ SplmtryData?: components["schemas"]["SupplementaryData1"] & unknown;
};
/**
* GroupHeader113
@@ -2634,13 +2215,13 @@ export interface components {
* }
*/
GroupHeader113: {
- MsgId: components["schemas"]["Max35Text"];
- CreDtTm: components["schemas"]["ISODateTime"];
- NbOfTxs: components["schemas"]["Max15NumericText"];
- TtlIntrBkSttlmAmt?: components["schemas"]["ActiveCurrencyAndAmount"];
- SttlmInf: components["schemas"]["SettlementInstruction15"];
- PmtTpInf?: components["schemas"]["PaymentTypeInformation28"];
- CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"];
+ MsgId: components["schemas"]["Max35Text"] & unknown;
+ CreDtTm: components["schemas"]["ISODateTime"] & unknown;
+ NbOfTxs: components["schemas"]["Max15NumericText"] & unknown;
+ TtlIntrBkSttlmAmt?: components["schemas"]["ActiveCurrencyAndAmount"] & unknown;
+ SttlmInf: components["schemas"]["SettlementInstruction15"] & unknown;
+ PmtTpInf?: components["schemas"]["PaymentTypeInformation28"] & unknown;
+ CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"] & unknown;
};
/**
* GroupHeader120
@@ -2672,24 +2253,13 @@ export interface components {
* }
*/
GroupHeader120: {
- /** @description MessageIdentification
- * Definition: Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message.
- * Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period.
- * */
- MsgId: components["schemas"]["Max35Text"];
- /** @description CreationDateTime
- * Date and time at which the message was created.
- * */
- CreDtTm: components["schemas"]["ISODateTime"];
- /** @description TransactionInformationAndStatus
- * Definition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).
- * Usage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.
- * */
- TxInfAndSts?: components["schemas"]["PaymentTransaction163"];
+ MsgId: components["schemas"]["Max35Text"] & unknown;
+ CreDtTm: components["schemas"]["ISODateTime"] & unknown;
+ TxInfAndSts?: components["schemas"]["PaymentTransaction163"] & unknown;
};
/**
* GroupHeader129
- * @description Set of characteristics shared by all individual transactions included in the message.
+ * @description Group Header Set of characteristics shared by all individual transactions included in the message.
*
* @example {
* "MsgId": 12345,
@@ -2743,12 +2313,12 @@ export interface components {
* }
*/
GroupHeader129: {
- MsgId: components["schemas"]["Max35Text"];
- CreDtTm: components["schemas"]["ISODateTime"];
- PmtInstrXpryDtTm?: components["schemas"]["ISODateTime"];
- NbOfTxs: components["schemas"]["Max15NumericText"];
- SttlmInf: components["schemas"]["SettlementInstruction15"];
- CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"];
+ MsgId: components["schemas"]["Max35Text"] & unknown;
+ CreDtTm: components["schemas"]["ISODateTime"] & unknown;
+ PmtInstrXpryDtTm?: components["schemas"]["ISODateTime"] & unknown;
+ NbOfTxs: components["schemas"]["Max15NumericText"] & unknown;
+ SttlmInf: components["schemas"]["SettlementInstruction15"] & unknown;
+ CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"] & unknown;
};
/**
* IBAN2007Identifier
@@ -2798,6 +2368,9 @@ export interface components {
ISOYear: string;
/**
* IdentificationAssignment3
+ * @description IdentificationAssignment
+ * Information that unambiguously identifies a message, as assigned by the assignor to the assignee.
+ *
* @example {
* "MsgId": 123,
* "CreDtTm": "2020-01-01T00:00:00Z",
@@ -2826,22 +2399,15 @@ export interface components {
* }
*/
IdentificationAssignment3: {
- MsgId: components["schemas"]["Max35Text"];
- /** @description CreationDateTime
- * Date and time at which the identification assignment was created.
- * */
- CreDtTm: components["schemas"]["ISODateTime"];
- /** @description Assignor
- * Party that assigns the identification assignment to another party. This is also the sender of the message.
- * */
- Assgnr: components["schemas"]["Party40Choice"];
- /** @description Assignee
- * Party that the identification assignment is assigned to. This is also the receiver of the message.
- * */
- Assgne: components["schemas"]["Party40Choice"];
+ MsgId: components["schemas"]["Max35Text"] & unknown;
+ CreDtTm: components["schemas"]["ISODateTime"] & unknown;
+ Assgnr: components["schemas"]["Party40Choice"] & unknown;
+ Assgne: components["schemas"]["Party40Choice"] & unknown;
};
/**
* IdentificationInformation4
+ * @description Information that locates and identifies a specific party or account.
+ *
* @example {
* "Pty": {
* "Id": {
@@ -2866,18 +2432,9 @@ export interface components {
* }
*/
IdentificationInformation4: {
- /** @description Party
- * Account owner that owes an amount of money or to whom an amount of money is due.
- * */
- Pty?: components["schemas"]["PartyIdentification135"];
- /** @description Account
- * Unambiguous identification of the account of a party.
- * */
- Acct?: components["schemas"]["CashAccount40"];
- /** @description Agent
- * Financial institution servicing an account for a party.
- * */
- Agt?: components["schemas"]["BranchAndFinancialInstitutionIdentification6"];
+ Pty: components["schemas"]["PartyIdentification135"] & unknown;
+ Acct?: components["schemas"]["CashAccount40"] & unknown;
+ Agt?: components["schemas"]["BranchAndFinancialInstitutionIdentification6"] & unknown;
};
/**
* IdentificationVerificationIndicator
@@ -2891,9 +2448,11 @@ export interface components {
IdentificationVerificationIndicator: boolean;
/**
* Instruction4Code
- * @description Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).
- * PHOA PhoneNextAgent Please advise/contact next agent by phone.
- * TELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.
+ * @description Specifies further instructions concerning the processing of a payment
+ * instruction, provided by the sending clearing agent to the next agent(s).
+ *
+ * PHOA: PhoneNextAgent Please advise/contact next agent by phone.
+ * TELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.
*
* @example PHOA
* @enum {string}
@@ -2909,33 +2468,21 @@ export interface components {
* }
*/
InstructionForCreditorAgent3: {
- /** @description Code
- * Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.
- * */
- Cd?: components["schemas"]["ExternalCreditorAgentInstruction1Code"];
- /** @description InstructionInformation
- * Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.
- * */
- InstrInf?: components["schemas"]["Max140Text"];
+ Cd?: components["schemas"]["ExternalCreditorAgentInstruction1Code"] & unknown;
+ InstrInf?: components["schemas"]["Max140Text"] & unknown;
};
/**
* InstructionForNextAgent1
- * @description Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.
+ * @description Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.
*
* @example {
* "Cd": "PHOA",
- * "InstrInf": "Please advise/contact next agent by phone"
+ * "InstrInf": "Please advise/contact next agent by phone."
* }
*/
InstructionForNextAgent1: {
- /** @description Code
- * Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.
- * */
- Cd?: components["schemas"]["Instruction4Code"];
- /** @description InstructionInformation
- * Further information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.
- * */
- InstrInf?: components["schemas"]["Max140Text"];
+ Cd?: components["schemas"]["Instruction4Code"] & unknown;
+ InstrInf?: components["schemas"]["Max140Text"] & unknown;
};
/**
* LEIIdentifier
@@ -2946,20 +2493,17 @@ export interface components {
LEIIdentifier: string;
/**
* LocalInstrument2Choice
+ * @description Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.
+ *
* @example {
* "Cd": "CH03"
* }
*/
LocalInstrument2Choice: {
- /** @description Code
- * Specifies the local instrument, as published in an external local instrument code list.
- * */
- Cd?: components["schemas"]["ExternalLocalInstrument1Code"];
- /** @description Proprietary
- * Specifies the local instrument, as a proprietary code
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalLocalInstrument1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* Max105Text
* @description Specifies a character string with a maximum length of 105 characters.
@@ -3054,6 +2598,12 @@ export interface components {
/**
* @description Specifies the terms used to formally address a person.
*
+ * DOCT: Doctor or Dr
+ * MADM: Madam
+ * MISS: Miss
+ * MIST: Mistress
+ * MIKS: Mx
+ *
* @example DOCT
* @enum {string}
*/
@@ -3080,18 +2630,9 @@ export interface components {
* }
*/
OrganisationIdentification29: {
- /** @description AnyBIC
- * Business identification code of the organisation.
- * */
- AnyBIC?: components["schemas"]["AnyBICDec2014Identifier"];
- /** @description LEI
- * Legal entity identification as an alternate identification for a party.
- * */
- LEI?: components["schemas"]["LEIIdentifier"];
- /** @description Other
- * Unique identification of an organisation, as assigned by an institution, using an identification scheme.
- * */
- Othr?: components["schemas"]["GenericOrganisationIdentification1"];
+ AnyBIC?: components["schemas"]["AnyBICDec2014Identifier"] & unknown;
+ LEI?: components["schemas"]["LEIIdentifier"] & unknown;
+ Othr?: components["schemas"]["GenericOrganisationIdentification1"] & unknown;
};
/**
* OrganisationIdentification39
@@ -3110,18 +2651,9 @@ export interface components {
* }
*/
OrganisationIdentification39: {
- /** @description AnyBIC
- * Business identification code of the organisation.
- * */
- AnyBIC?: components["schemas"]["AnyBICDec2014Identifier"];
- /** @description LEI
- * Legal entity identification as an alternate identification for a party.
- * */
- LEI?: components["schemas"]["LEIIdentifier"];
- /** @description Other
- * Unique identification of an organisation, as assigned by an institution, using an identification scheme.
- * */
- Othr?: components["schemas"]["GenericOrganisationIdentification3"];
+ AnyBIC?: components["schemas"]["AnyBICDec2014Identifier"] & unknown;
+ LEI?: components["schemas"]["LEIIdentifier"] & unknown;
+ Othr?: components["schemas"]["GenericOrganisationIdentification3"] & unknown;
};
/**
* OrganisationIdentificationSchemeName1Choice
@@ -3132,15 +2664,13 @@ export interface components {
* }
*/
OrganisationIdentificationSchemeName1Choice: {
- /** @description Code
- * Name of the identification scheme, in a coded form as published in an external list.
- * */
- Cd?: components["schemas"]["ExternalOrganisationIdentification1Code"];
- /** @description Proprietary
- * Name of the identification scheme, in a free text form.
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd?: components["schemas"]["ExternalOrganisationIdentification1Code"] & unknown;
+ Prtry?: components["schemas"]["Max35Text"] & unknown;
+ } & ({
+ Cd?: unknown;
+ } | {
+ Prtry?: unknown;
+ });
/**
* OtherContact1
* @description Communication device number or electronic address used for communication.
@@ -3151,17 +2681,13 @@ export interface components {
* }
*/
OtherContact1: {
- /** @description ChannelType
- * Method used to contact the financial institution's contact for the specific tax region.
- * */
- ChanlTp: components["schemas"]["Max4Text"];
- /** @description Identifier
- * Communication value such as phone number or email address.
- * */
- Id?: components["schemas"]["Max128Text"];
+ ChanlTp: components["schemas"]["Max4Text"] & unknown;
+ Id?: components["schemas"]["Max128Text"] & unknown;
};
/**
* PacsError_FIToFIPaymentStatusReportV15
+ * @description This message is sent by an account servicing institution to an account owner. It is used to inform the account owner about the status of a payment initiation.
+ *
* @example {
* "GrpHdr": {
* "MsgId": 12345,
@@ -3198,14 +2724,13 @@ export interface components {
* }
*/
PacsError_FIToFIPaymentStatusReportV15: {
- GrpHdr: components["schemas"]["GroupHeader120"];
- TxInfAndSts?: components["schemas"]["PaymentTransaction163"];
- SplmtryData?: components["schemas"]["SupplementaryData1"];
+ GrpHdr: components["schemas"]["GroupHeader120"] & unknown;
+ TxInfAndSts?: components["schemas"]["PaymentTransaction163"] & unknown;
+ SplmtryData?: components["schemas"]["SupplementaryData1"] & unknown;
};
/**
* PacsStatus_FIToFIPaymentStatusReportV15
- * @description Unsure on description.
- *
+ * @description The PacsStatus message is sent by a financial institution to another financial institution as a response to the FIToFIPaymentStatusReport message. The message provides information on the status of a payment instruction and its underlying individual transactions.
* @example {
* "GrpHdr": {
* "MsgId": 12345,
@@ -3234,7 +2759,7 @@ export interface components {
* }
*/
PacsStatus_FIToFIPaymentStatusReportV15: {
- GrpHdr: components["schemas"]["GroupHeader120"];
+ GrpHdr: components["schemas"]["GroupHeader120"] & unknown;
};
/**
* Party38Choice
@@ -3253,15 +2778,10 @@ export interface components {
* }
*/
Party38Choice: {
- /** @description Organisation
- * Unique and unambiguous way to identify an organisation.
- * */
- OrgId?: components["schemas"]["OrganisationIdentification29"];
- /** @description PrivateIdentification
- * Unique and unambiguous identification of a person, for example a passport.
- * */
- PrvtId?: components["schemas"]["PersonIdentification13"];
- } & (unknown | unknown);
+ OrgId: components["schemas"]["OrganisationIdentification29"] & unknown;
+ } | {
+ PrvtId: components["schemas"]["PersonIdentification13"] & unknown;
+ };
/**
* Party40Choice
* @description Identification of a person, an organisation or a financial institution.
@@ -3302,15 +2822,10 @@ export interface components {
* }
*/
Party40Choice: {
- /** @description Party
- * Identification of a person or an organisation.
- * */
- Pty?: components["schemas"]["PartyIdentification135"];
- /** @description Agent
- * Identification of a financial institution.
- * */
- Agt?: components["schemas"]["BranchAndFinancialInstitutionIdentification6"];
- } & (unknown | unknown);
+ Pty: components["schemas"]["PartyIdentification135"] & unknown;
+ } | {
+ Agt: components["schemas"]["BranchAndFinancialInstitutionIdentification6"] & unknown;
+ };
/**
* Party52Choice
* @description NOTE: Unsure on the description.
@@ -3328,15 +2843,10 @@ export interface components {
* }
*/
Party52Choice: {
- /** @description Organisation
- * Unique and unambiguous way to identify an organisation.
- * */
- OrgId?: components["schemas"]["OrganisationIdentification39"];
- /** @description Person
- * Unique and unambiguous identification of a person, for example a passport
- * */
- PrvtId?: components["schemas"]["PersonIdentification18"];
- } & (unknown | unknown);
+ OrgId: components["schemas"]["OrganisationIdentification39"] & unknown;
+ } | {
+ PrvtId: components["schemas"]["PersonIdentification18"] & unknown;
+ };
/**
* PartyIdentification135
* @description Specifies the identification of a person or an organisation.
@@ -3383,25 +2893,11 @@ export interface components {
* }
*/
PartyIdentification135: {
- /** @description Name
- * Name by which a party is known and which is usually used to identify that party.
- * */
- Nm?: components["schemas"]["Max140Text"];
- /** @description PostalAddress
- * Information that locates and identifies a specific address, as defined by postal services.
- * */
- PstlAdr?: components["schemas"]["PostalAddress24"];
- /** @description Identification
- * Unique and unambiguous way to identify an organisation.
- * */
- Id?: components["schemas"]["Party38Choice"];
- /** @description CountryOfResidence Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.
- * */
- CtryOfRes?: components["schemas"]["CountryCode"];
- /** @description ContactDetails
- * Set of elements used to indicate how to contact the party.
- * */
- CtctDtls?: components["schemas"]["Contact4"];
+ Nm?: components["schemas"]["Max140Text"] & unknown;
+ PstlAdr?: components["schemas"]["PostalAddress24"] & unknown;
+ Id: components["schemas"]["Party38Choice"] & unknown;
+ CtryOfRes?: components["schemas"]["CountryCode"] & unknown;
+ CtctDtls?: components["schemas"]["Contact4"] & unknown;
};
/**
* PartyIdentification272
@@ -3438,31 +2934,16 @@ export interface components {
* "PhneNb": "+123-123-321",
* "MobNb": "+123-123-321",
* "FaxNb": "+123-123-321",
- * "EmailAdr": null
+ * "EmailAdr": "example@example.com"
* }
* }
*/
PartyIdentification272: {
- /** @description Name
- * Name by which a party is known and which is usually used to identify that party.
- * */
- Nm?: components["schemas"]["Max140Text"];
- /** @description Postal Address
- * Information that locates and identifies a specific address, as defined by postal services.
- * */
- PstlAdr?: components["schemas"]["PostalAddress27"];
- /** @description Identification
- * Unique and unambiguous identification of a party.
- * */
- Id?: components["schemas"]["Party52Choice"];
- /** @description Country of Residence
- * Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.
- * */
- CtryOfRes?: components["schemas"]["CountryCode"];
- /** @description Contact Details
- * Set of elements used to indicate how to contact the party.
- * */
- CtctDtls?: components["schemas"]["Contact13"];
+ Nm?: components["schemas"]["Max140Text"] & unknown;
+ PstlAdr?: components["schemas"]["PostalAddress27"] & unknown;
+ Id: components["schemas"]["Party52Choice"] & unknown;
+ CtryOfRes?: components["schemas"]["CountryCode"] & unknown;
+ CtctDtls?: components["schemas"]["Contact13"] & unknown;
};
/**
* PaymentIdentification13
@@ -3477,31 +2958,11 @@ export interface components {
* }
*/
PaymentIdentification13: {
- /** @description InstructionIdentification
- * Definition: Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.
- * Usage: The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
- * */
- InstrId?: components["schemas"]["Max35Text"];
- /** @description EndToEndIdentification
- * Definition: Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
- * Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.
- * Usage: In case there are technical limitations to pass on multiple references, the end-to-end identification must be passed on throughout the entire end-to-end chain.
- * */
- EndToEndId: components["schemas"]["Max35Text"];
- /** @description TransactionIdentification
- * Definition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.
- * Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level.
- * Usage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.
- * */
- TxId?: components["schemas"]["Max35Text"];
- /** @description UETR
- * Universally unique identifier to provide an end-to-end reference of a payment transaction.
- * */
- UETR?: components["schemas"]["UUIDv4Identifier"];
- /** @description ClearingSystemReference
- * Unique reference, as assigned by a clearing system, to unambiguously identify the instruction.
- * */
- ClrSysRef?: components["schemas"]["Max35Text"];
+ InstrId?: components["schemas"]["Max35Text"] & unknown;
+ EndToEndId?: components["schemas"]["Max35Text"] & unknown;
+ TxId: components["schemas"]["Max35Text"] & unknown;
+ UETR?: components["schemas"]["UUIDv4Identifier"] & unknown;
+ ClrSysRef?: components["schemas"]["Max35Text"] & unknown;
};
/**
* PaymentTransaction163
@@ -3529,18 +2990,18 @@ export interface components {
* }
*/
PaymentTransaction163: {
- StsId?: components["schemas"]["Max35Text"];
- OrgnlInstrId?: components["schemas"]["Max35Text"];
- OrgnlEndToEndId?: components["schemas"]["Max35Text"];
- OrgnlTxId?: components["schemas"]["Max35Text"];
- OrgnlUETR?: components["schemas"]["UUIDv4Identifier"];
- TxSts?: components["schemas"]["ExternalPaymentTransactionStatus1Code"];
- StsRsnInf?: components["schemas"]["StatusReasonInformation14"];
- AccptncDtTm?: components["schemas"]["ISODateTime"];
- AcctSvcrRef?: components["schemas"]["Max35Text"];
- ClrSysRef?: components["schemas"]["Max35Text"];
- ExctnConf?: components["schemas"]["Exact32HexBinaryText"];
- SplmtryData?: components["schemas"]["SupplementaryData1"];
+ StsId?: components["schemas"]["Max35Text"] & unknown;
+ OrgnlInstrId?: components["schemas"]["Max35Text"] & unknown;
+ OrgnlEndToEndId?: components["schemas"]["Max35Text"] & unknown;
+ OrgnlTxId?: components["schemas"]["Max35Text"] & unknown;
+ OrgnlUETR?: components["schemas"]["UUIDv4Identifier"] & unknown;
+ TxSts?: components["schemas"]["ExternalPaymentTransactionStatus1Code"] & unknown;
+ StsRsnInf?: components["schemas"]["StatusReasonInformation14"] & unknown;
+ AccptncDtTm?: components["schemas"]["ISODateTime"] & unknown;
+ AcctSvcrRef?: components["schemas"]["Max35Text"] & unknown;
+ ClrSysRef?: components["schemas"]["Max35Text"] & unknown;
+ ExctnConf?: components["schemas"]["Exact32HexBinaryText"] & unknown;
+ SplmtryData?: components["schemas"]["SupplementaryData1"] & unknown;
};
/**
* PaymentTypeInformation28
@@ -3561,27 +3022,11 @@ export interface components {
* }
*/
PaymentTypeInformation28: {
- /** @description InstructionPriority
- * 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.
- * */
InstrPrty?: components["schemas"]["Priority2Code"];
- /** @description ClearingChannel
- * Specifies the clearing channel to be used to process the payment instruction.
- * */
ClrChanl?: components["schemas"]["ClearingChannel2Code"];
- /** @description ServiceLevel
- * Agreement under which or rules under which the transaction should be processed.
- * */
- SvcLvl?: components["schemas"]["ServiceLevel8Choice"];
- /** @description LocalInstrument
- * Definition: User community specific instrument.
- * Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
- * */
- LclInstrm?: components["schemas"]["LocalInstrument2Choice"];
- /** @description CategoryPurpose
- * Specifies the high level purpose of the instruction based on a set of pre-defined categories.
- * */
- CtgyPurp?: components["schemas"]["CategoryPurpose1Choice"];
+ SvcLvl?: components["schemas"]["ServiceLevel8Choice"] & unknown;
+ LclInstrm?: components["schemas"]["LocalInstrument2Choice"] & unknown;
+ CtgyPurp?: components["schemas"]["CategoryPurpose1Choice"] & unknown;
};
/**
* PercentageRate
@@ -3607,14 +3052,8 @@ export interface components {
* }
*/
PersonIdentification13: {
- /** @description DateAndPlaceOfBirth
- * Date and place of birth of a person.
- * */
- DtAndPlcOfBirth?: components["schemas"]["DateAndPlaceOfBirth1"];
- /** @description Other
- * Unique identification of a person, as assigned by an institution, using an identification scheme.
- * */
- Othr?: components["schemas"]["GenericPersonIdentification1"];
+ DtAndPlcOfBirth?: components["schemas"]["DateAndPlaceOfBirth1"] & unknown;
+ Othr?: components["schemas"]["GenericPersonIdentification1"] & unknown;
};
/**
* PersonIdentification18
@@ -3635,14 +3074,8 @@ export interface components {
* }
*/
PersonIdentification18: {
- /** @description DateAndPlaceOfBirth
- * Date and place of birth of a person.
- * */
- DtAndPlcOfBirth?: components["schemas"]["DateAndPlaceOfBirth1"];
- /** @description Other
- * Unique identification of a person, as assigned by an institution, using an identification scheme.
- * */
- Othr?: components["schemas"]["GenericPersonIdentification2"];
+ DtAndPlcOfBirth?: components["schemas"]["DateAndPlaceOfBirth1"] & unknown;
+ Othr?: components["schemas"]["GenericPersonIdentification2"] & unknown;
};
/**
* PersonIdentificationSchemeName1Choice
@@ -3653,15 +3086,10 @@ export interface components {
* }
*/
PersonIdentificationSchemeName1Choice: {
- /** @description Code
- * Name of the identification scheme, in a coded form as published in an external list
- * */
- Cd?: components["schemas"]["ExternalPersonIdentification1Code"];
- /** @description Proprietary
- * Name of the identification scheme, in a free text form
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalPersonIdentification1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* PhoneNumber
* @description Double check this regex.
@@ -3758,6 +3186,12 @@ export interface components {
* PreferredContactMethod1Code
* @description Preferred method used to reach the individual contact within an organisation.
*
+ * LETT: Letter
+ * MAIL: Email
+ * PHON: Phone
+ * FAXX: Fax
+ * CELL: Mobile phone
+ *
* @example CELL
* @enum {string}
*/
@@ -3765,6 +3199,11 @@ export interface components {
/**
* PreferredContactMethod2Code
* @description Preferred method used to reach the individual contact within an organisation.
+ * LETT: Letter
+ * MAIL: Email
+ * PHON: Phone
+ * FAXX: Fax
+ * CELL: Mobile phone
*
* @example MAIL
* @enum {string}
@@ -3772,7 +3211,11 @@ export interface components {
PreferredContactMethod2Code: "LETT" | "MAIL" | "PHON" | "FAXX" | "CELL";
/**
* Priority2Code
- * @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.
+ * @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.
+ *
+ * HIGH: High priority
+ * NORM: Normal priority
*
* @example HIGH
* @enum {string}
@@ -3790,60 +3233,40 @@ export interface components {
* }
*/
ProxyAccountIdentification1: {
- /** @description Type
- *
- * Type of the proxy identification.
- * */
- Tp?: components["schemas"]["ProxyAccountType1Choice"];
- /** @description Identification
- *
- * Identification used to indicate the account identification under another specified name.
- * */
- Id: components["schemas"]["Max2048Text"];
+ Tp?: components["schemas"]["ProxyAccountType1Choice"] & unknown;
+ Id: components["schemas"]["Max2048Text"] & unknown;
};
/**
* ProxyAccountType1Choice
- * @description ProxyAccountType1Choice
- *
- * Specifies the scheme used for the identification of an account alias.
+ * @description Specifies the type of the proxy account.
*
* @example {
- * "Cd": "CH03"
+ * "Cd": "EMAIL"
* }
*/
ProxyAccountType1Choice: {
- /** @description Code
- *
- * Name of the identification scheme, in a coded form as published in an external list.
- * */
- Cd?: components["schemas"]["ExternalProxyAccountType1Code"];
- /** @description Proprietary
- *
- * Name of the identification scheme, in a free text form.
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalProxyAccountType1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* Purpose2Choice
* @description Specifies the underlying reason for the payment transaction.
- * Usage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.
+ *
+ * Usage: Purpose is used by the end-customers, that is initiating party,
+ * (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose
+ * is a content element, which is not used for processing by any of the agents involved in the payment
+ * chain.
*
* @example {
* "Cd": "CH03"
* }
*/
Purpose2Choice: {
- /** @description Code
- *
- * Underlying reason for the payment transaction, as published in an external purpose code list.
- * */
- Cd?: components["schemas"]["ExternalPurpose1Code"];
- /** @description Proprietary
- *
- * Purpose, in a proprietary form.
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalPurpose1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* RegulatoryAuthority2
* @description Information about an entity requiring the regulatory reporting information.
@@ -3854,16 +3277,8 @@ export interface components {
* }
*/
RegulatoryAuthority2: {
- /** @description Name
- *
- * Name of the entity requiring the regulatory reporting information.
- * */
- Nm?: components["schemas"]["Max140Text"];
- /** @description Country
- *
- * Country of the entity that requires the regulatory reporting information.
- * */
- Ctry?: components["schemas"]["CountryCode"];
+ Nm?: components["schemas"]["Max140Text"] & unknown;
+ Ctry?: components["schemas"]["CountryCode"] & unknown;
};
/**
* RegulatoryReporting3
@@ -3882,15 +3297,8 @@ export interface components {
* }
*/
RegulatoryReporting3: {
- /** @description DebitCreditReportingIndicator
- * 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.
- * */
- DbtCdtRptgInd?: components["schemas"]["RegulatoryReportingType1Code"];
- /** @description Authority
- *
- * Entity requiring the regulatory reporting information.
- * */
- Authrty?: components["schemas"]["RegulatoryAuthority2"];
+ DbtCdtRptgInd?: components["schemas"]["RegulatoryReportingType1Code"] & unknown;
+ Authrty?: components["schemas"]["RegulatoryAuthority2"] & unknown;
/** @description Details
* 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.
* */
@@ -3898,7 +3306,12 @@ export interface components {
};
/**
* RegulatoryReportingType1Code
- * @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.
+ * @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.
+ *
+ * CRED: Regulatory reporting applies to the credit side of the transaction.
+ * DEBT: Regulatory reporting applies to the debit side of the transaction.
+ * BOTH: Regulatory reporting applies to both debit and credit sides of the transaction.
*
* @example BOTH
* @enum {string}
@@ -3913,15 +3326,10 @@ export interface components {
* }
*/
ServiceLevel8Choice: {
- /** @description Code
- * Specifies a pre-agreed service or level of service between the parties, as published in an external service level code list.
- * */
- Cd?: components["schemas"]["ExternalServiceLevel1Code"];
- /** @description Proprietary
- * Specifies a pre-agreed service or level of service between the parties, as a proprietary code.
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalServiceLevel1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* SettlementInstruction15
* @description Specifies the details on how the settlement of the original transaction(s) between the
@@ -3970,40 +3378,35 @@ export interface components {
* }
*/
SettlementInstruction15: {
- /** @description SettlementMethod
- * Method used to settle the (batch of) payment instructions.
- * */
SttlmMtd: components["schemas"]["SettlementMethod1Code"];
- /** @description PaymentTypeInformation
- * */
PmtTpInf?: components["schemas"]["PaymentTypeInformation28"];
};
/**
* SettlementMethod1Code
* @description Specifies the method used to settle the credit transfer instruction.
*
+ * INDA: Indirect Account
+ * INGA: Indirect Agent
+ * COVE: Cover
+ * CLRG: Clearing
+ *
* @example CLRG
* @enum {string}
*/
SettlementMethod1Code: "INDA" | "INGA" | "COVE" | "CLRG";
/**
* StatusReason6Choice
- * @description Unsure on description.
+ * @description Specifies the reason for the status.
*
* @example {
* "Cd": "AGNT"
* }
*/
StatusReason6Choice: {
- /** @description Code
- * Reason for the status, as published in an external reason code list.
- * */
- Cd?: components["schemas"]["ExternalStatusReason1Code"];
- /** @description Proprietary
- * Reason for the status, in a proprietary form.
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalStatusReason1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* StatusReasonInformation14
* @description Unsure on description.
@@ -4030,15 +3433,9 @@ export interface components {
* }
*/
StatusReasonInformation14: {
- /** @description Originator
- * Party that issues the status. */
- Orgtr?: components["schemas"]["PartyIdentification272"];
- /** @description Reason
- * Specifies the reason for the status report. */
- Rsn?: components["schemas"]["StatusReason6Choice"];
- /** @description AdditionalInformation
- * Additional information about the status report. */
- AddtlInf?: components["schemas"]["Max105Text"];
+ Orgtr?: components["schemas"]["PartyIdentification272"] & unknown;
+ Rsn?: components["schemas"]["StatusReason6Choice"] & unknown;
+ AddtlInf?: components["schemas"]["Max105Text"] & unknown;
};
/**
* StructuredRegulatoryReporting3
@@ -4059,38 +3456,20 @@ export interface components {
* }
*/
StructuredRegulatoryReporting3: {
- /** @description Type
- *
- * Specifies the type of the information supplied in the regulatory reporting details.
- * */
- Tp?: components["schemas"]["Max35Text"];
- /** @description Date
- *
- * Date related to the specified type of regulatory reporting details.
- * */
- Dt?: components["schemas"]["ISODate"];
- /** @description Country
- *
- * Country related to the specified type of regulatory reporting details.
- * */
- Ctry?: components["schemas"]["CountryCode"];
- /** @description Code
- * Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.
- * */
- Cd?: components["schemas"]["Max10Text"];
- /** @description Amount
- *
- * Amount of money to be reported for regulatory and statutory requirements.
- * */
- Amt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
+ Tp?: components["schemas"]["Max35Text"] & unknown;
+ Dt?: components["schemas"]["ISODate"] & unknown;
+ Ctry?: components["schemas"]["CountryCode"] & unknown;
+ Cd?: components["schemas"]["Max10Text"] & unknown;
+ Amt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown;
/** @description Information
+ *
* Additional details that cater for specific domestic regulatory requirements.
* */
Inf?: components["schemas"]["Max35Text"] | components["schemas"]["Max35Text"][];
};
/**
* SupplementaryData1
- * @description Additional information that can not be captured in the structured fields and/or any other specific block.
+ * @description Additional information that cannot be captured in the structured fields and/or any other specific block.
*
* @example {
* "PlcAndNm": "Additional information",
@@ -4101,15 +3480,8 @@ export interface components {
* }
*/
SupplementaryData1: {
- /** @description PlaceAndName
- * Unambiguous reference to the location where the supplementary data must be inserted in the message instance.
- * */
- PlcAndNm?: components["schemas"]["Max350Text"];
- /** @description Envelope
- * Technical element wrapping the supplementary data.
- * Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
- * */
- Envlp: components["schemas"]["SupplementaryDataEnvelope1"];
+ PlcAndNm?: components["schemas"]["Max350Text"] & unknown;
+ Envlp: components["schemas"]["SupplementaryDataEnvelope1"] & unknown;
};
/**
* SupplementaryDataEnvelope1
@@ -4145,21 +3517,9 @@ export interface components {
* }
*/
TaxAmount3: {
- /** @description Rate
- *
- * Rate used to calculate the tax.
- * */
- Rate?: components["schemas"]["PercentageRate"];
- /** @description TaxableBaseAmount
- *
- * Amount of money on which the tax is based.
- * */
- TaxblBaseAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
- /** @description TotalAmount
- *
- * Total amount that is the result of the calculation of the tax for the record.
- * */
- TtlAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
+ Rate?: components["schemas"]["PercentageRate"] & unknown;
+ TaxblBaseAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown;
+ TtlAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown;
/** @description Details
*
* Set of elements used to provide details on the tax period and amount.
@@ -4176,16 +3536,8 @@ export interface components {
* }
*/
TaxAuthorisation1: {
- /** @description Title
- *
- * Title or position of debtor or the debtor's authorised representative.
- * */
- Titl?: components["schemas"]["Max35Text"];
- /** @description Name
- *
- * Name of the debtor or the debtor's authorised representative.
- * */
- Nm?: components["schemas"]["Max140Text"];
+ Titl?: components["schemas"]["Max35Text"] & unknown;
+ Nm?: components["schemas"]["Max140Text"] & unknown;
};
/**
* TaxData1
@@ -4230,56 +3582,16 @@ export interface components {
* }
*/
TaxData1: {
- /** @description Creditor
- *
- * Party on the credit side of the transaction to which the tax applies.
- * */
- Cdtr?: components["schemas"]["TaxParty1"];
- /** @description Debtor
- *
- * Party on the debit side of the transaction to which the tax applies.
- * */
- Dbtr?: components["schemas"]["TaxParty2"];
- /** @description UltimateDebtor
- *
- * Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.
- * */
- UltmtDbtr?: components["schemas"]["TaxParty2"];
- /** @description AdministrationZone
- *
- * Territorial part of a country to which the tax payment is related.
- * */
- AdmstnZone?: components["schemas"]["Max35Text"];
- /** @description ReferenceNumber
- *
- * Tax reference information that is specific to a taxing agency.
- * */
- RefNb?: components["schemas"]["Max140Text"];
- /** @description Method
- *
- * Method used to indicate the underlying business or how the tax is paid.
- * */
- Mtd?: components["schemas"]["Max35Text"];
- /** @description TotalTaxableBaseAmount
- *
- * Total amount of money on which the tax is based.
- * */
- TtlTaxblBaseAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
- /** @description TotalTaxAmount
- *
- * Total amount of money as result of the calculation of the tax.
- * */
- TtlTaxAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
- /** @description Date
- *
- * Date by which tax is due.
- * */
- Dt?: components["schemas"]["ISODate"];
- /** @description SequenceNumber
- *
- * Sequential number of the tax report
- * */
- SeqNb?: components["schemas"]["Number"];
+ Cdtr?: components["schemas"]["TaxParty1"] & unknown;
+ Dbtr?: components["schemas"]["TaxParty2"] & unknown;
+ UltmtDbtr?: components["schemas"]["TaxParty2"] & unknown;
+ AdmstnZone?: components["schemas"]["Max35Text"] & unknown;
+ RefNb?: components["schemas"]["Max140Text"] & unknown;
+ Mtd?: components["schemas"]["Max35Text"] & unknown;
+ TtlTaxblBaseAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown;
+ TtlTaxAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown;
+ Dt?: components["schemas"]["ISODate"] & unknown;
+ SeqNb?: components["schemas"]["Number"] & unknown;
/** @description Record
*
* Details of the tax record.
@@ -4297,21 +3609,9 @@ export interface components {
* }
*/
TaxParty1: {
- /** @description TaxIdentification
- *
- * Tax identification number of the creditor.
- * */
- TaxId?: components["schemas"]["Max35Text"];
- /** @description RegistrationIdentification
- *
- * Unique identification, as assigned by an organisation, to unambiguously identify a party.
- * */
- RegnId?: components["schemas"]["Max35Text"];
- /** @description TaxType
- *
- * Type of tax payer.
- * */
- TaxTp?: components["schemas"]["Max35Text"];
+ TaxId?: components["schemas"]["Max35Text"] & unknown;
+ RegnId?: components["schemas"]["Max35Text"] & unknown;
+ TaxTp?: components["schemas"]["Max35Text"] & unknown;
};
/**
* TaxParty2
@@ -4328,26 +3628,10 @@ export interface components {
* }
*/
TaxParty2: {
- /** @description TaxIdentification
- *
- * Tax identification number of the debtor.
- * */
- TaxId?: components["schemas"]["Max35Text"];
- /** @description RegistrationIdentification
- *
- * Unique identification, as assigned by an organisation, to unambiguously identify a party.
- * */
- RegnId?: components["schemas"]["Max35Text"];
- /** @description TaxType
- *
- * Type of tax payer.
- * */
- TaxTp?: components["schemas"]["Max35Text"];
- /** @description Authorisation
- *
- * Details of the authorised tax paying party.
- * */
- Authstn?: components["schemas"]["TaxAuthorisation1"];
+ TaxId?: components["schemas"]["Max35Text"] & unknown;
+ RegnId?: components["schemas"]["Max35Text"] & unknown;
+ TaxTp?: components["schemas"]["Max35Text"] & unknown;
+ Authstn?: components["schemas"]["TaxAuthorisation1"] & unknown;
};
/**
* TaxPeriod3
@@ -4363,21 +3647,9 @@ export interface components {
* }
*/
TaxPeriod3: {
- /** @description FromToDate
- *
- * Range of time between a start date and an end date for which the tax report is provided.
- * */
- FrToDt?: components["schemas"]["DatePeriod2"];
- /** @description Type
- *
- * Identification of the period related to the tax payment.
- * */
- Tp?: components["schemas"]["TaxRecordPeriod1Code"];
- /** @description Year
- *
- * Year related to the tax payment.
- * */
- Yr?: components["schemas"]["ISOYear"];
+ FrToDt?: components["schemas"]["DatePeriod2"] & unknown;
+ Tp?: components["schemas"]["TaxRecordPeriod1Code"] & unknown;
+ Yr?: components["schemas"]["ISOYear"] & unknown;
};
/**
* TaxRecord3
@@ -4391,67 +3663,41 @@ export interface components {
* "CertId": 123456789,
* "FrmsCd": 123456789,
* "Prd": {
- * "FrstDay": "2019-01-01",
- * "LastDay": "2019-12-31"
+ * "Yr": 2019,
+ * "Tp": "MM01",
+ * "FrToDt": {
+ * "FrDt": "2019-01-01",
+ * "ToDt": "2019-12-31"
+ * }
* },
* "TaxAmt": {
* "Rate": 0.2,
- * "TaxblBaseAmt": 1000,
- * "TtlAmt": 200
+ * "TaxblBaseAmt": {
+ * "Ccy": "EUR",
+ * "Amt": 1000
+ * },
+ * "TtlAmt": {
+ * "Ccy": "EUR",
+ * "Amt": 200
+ * }
* },
* "AddtlInf": "VAT applicable"
* }
*/
TaxRecord3: {
- /** @description AdditionalInformation
- *
- * Further details of the tax record.
- * */
- AddtlInf?: components["schemas"]["Max140Text"];
- /** @description CertificateIdentification
- *
- * Identification number of the tax report as assigned by the taxing authority.
- * */
- CertId?: components["schemas"]["Max35Text"];
- /** @description Category
- *
- * Specifies the tax code as published by the tax authority.
- * */
- Ctgy?: components["schemas"]["Max35Text"];
- /** @description CategoryDetails
- *
- * Provides further details of the category tax code.
- * */
- CtgyDtls?: components["schemas"]["Max35Text"];
- /** @description DebtorStatus
- *
- * Code provided by local authority to identify the status of the party that has drawn up the settlement document.
- * */
- DbtrSts?: components["schemas"]["Max35Text"];
- /** @description FormsCode
- *
- * Identifies, in a coded form, on which template the tax report is to be provided.
- * */
- FrmsCd?: components["schemas"]["Max35Text"];
- /** @description Period
- *
- * Set of elements used to provide details on the period of time related to the tax payment.
- * */
- Prd?: components["schemas"]["TaxPeriod3"];
- /** @description TaxAmount
- *
- * Set of elements used to provide information on the amount of the tax record.
- * */
- TaxAmt?: components["schemas"]["TaxAmount3"];
- /** @description Type
- *
- * High level code to identify the type of tax details.
- * */
- Tp?: components["schemas"]["Max35Text"];
+ AddtlInf?: components["schemas"]["Max140Text"] & unknown;
+ CertId?: components["schemas"]["Max35Text"] & unknown;
+ Ctgy?: components["schemas"]["Max35Text"] & unknown;
+ CtgyDtls?: components["schemas"]["Max35Text"] & unknown;
+ DbtrSts?: components["schemas"]["Max35Text"] & unknown;
+ FrmsCd?: components["schemas"]["Max35Text"] & unknown;
+ Prd?: components["schemas"]["TaxPeriod3"] & unknown;
+ TaxAmt?: components["schemas"]["TaxAmount3"] & unknown;
+ Tp?: components["schemas"]["Max35Text"] & unknown;
};
/**
* TaxRecordDetails3
- * @description Details on the tax period and amount
+ * @description Details on the tax period and amount.
*
* @example {
* "Prd": {
@@ -4469,16 +3715,8 @@ export interface components {
* }
*/
TaxRecordDetails3: {
- /** @description Period
- *
- * Set of elements used to provide details on the period of time related to the tax payment.
- * */
- Prd?: components["schemas"]["TaxPeriod3"];
- /** @description Amount
- *
- * Underlying tax amount related to the specified period.
- * */
- Amt: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
+ Prd?: components["schemas"]["TaxPeriod3"] & unknown;
+ Amt: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown;
};
/**
* TaxRecordPeriod1Code
@@ -4509,6 +3747,8 @@ export interface components {
TaxRecordPeriod1Code: "MM01" | "MM02" | "MM03" | "MM04" | "MM05" | "MM06" | "MM07" | "MM08" | "MM09" | "MM10" | "MM11" | "MM12" | "QTR1" | "QTR2" | "QTR3" | "QTR4" | "HLF1" | "HLF2";
/**
* TermsRequest_FIToFICustomerCreditProposal
+ * @description This message is sent by a financial institution to a financial institution to propose the terms of a credit to a customer.
+ *
* @example {
* "GrpHdr": {
* "MsgId": 123456789,
@@ -4540,10 +3780,12 @@ export interface components {
* }
*/
TermsRequest_FIToFICustomerCreditProposal: {
- GrpHdr: components["schemas"]["GroupHeader129"];
+ GrpHdr: components["schemas"]["GroupHeader129"] & unknown;
};
/**
* TermsResponse_FIToFICustomerCreditConfirmation
+ * @description This message is sent by the initiating party to the executing party, directly or through one or more intermediaries, to confirm the credit transfer transaction.
+ *
* @example {
* "GrpHdr": {
* "MsgId": 123456789,
@@ -4575,8 +3817,8 @@ export interface components {
* }
*/
TermsResponse_FIToFICustomerCreditConfirmation: {
- GrpHdr: components["schemas"]["GroupHeader129"];
- CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"];
+ GrpHdr: components["schemas"]["GroupHeader129"] & unknown;
+ CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"] & unknown;
};
/**
* UUIDv4Identifier
@@ -4585,22 +3827,22 @@ export interface components {
UUIDv4Identifier: string;
/**
* VerificationReason1Choice
+ * @description Choice of format for the verification reason.
+ * Only one, between the coded and the proprietary, can be chosen.
+ *
* @example {
* "Cd": "AGNT"
* }
*/
VerificationReason1Choice: {
- /** @description Code
- * Reason why the verified identification information is incorrect, as published in an external reason code list.
- * */
- Cd?: components["schemas"]["ExternalVerificationReason1Code"];
- /** @description Proprietary
- * Reason why the verified identification information is incorrect, in a free text form.
- * */
- Prtry?: components["schemas"]["Max35Text"];
- } & (unknown | unknown);
+ Cd: components["schemas"]["ExternalVerificationReason1Code"] & unknown;
+ } | {
+ Prtry: components["schemas"]["Max35Text"] & unknown;
+ };
/**
* VerificationReport4
+ * @description VerificationReport
+ * Provides information about the verification of party and/or account identification information.
* @example {
* "OrgnlId": 1.2345678901234568e+33,
* "Vrfctn": true,
@@ -4653,26 +3895,11 @@ export interface components {
* }
*/
VerificationReport4: {
- /** @description OriginalIdentification
- * Unique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.
- * */
- OrgnlId: components["schemas"]["Max35Text"];
- /** @description Verification
- * Identifies whether the party and/or account information received is correct. Boolean value.
- * */
- Vrfctn: components["schemas"]["IdentificationVerificationIndicator"];
- /** @description Reason.
- * Specifies the reason why the verified identification information is incorrect.
- * */
- Rsn?: components["schemas"]["VerificationReason1Choice"];
- /** @description OriginalPartyAndAccountIdentification
- * Provides party and/or account identification information as given in the original message.
- * */
- OrgnlPtyAndAcctId?: components["schemas"]["IdentificationInformation4"];
- /** @description UpdatedPartyAndAccountIdentification
- * Provides party and/or account identification information.
- * */
- UpdtdPtyAndAcctId?: components["schemas"]["IdentificationInformation4"];
+ OrgnlId: components["schemas"]["Max35Text"] & unknown;
+ Vrfctn: components["schemas"]["IdentificationVerificationIndicator"] & unknown;
+ Rsn?: components["schemas"]["VerificationReason1Choice"] & unknown;
+ OrgnlPtyAndAcctId?: components["schemas"]["IdentificationInformation4"] & unknown;
+ UpdtdPtyAndAcctId: components["schemas"]["IdentificationInformation4"] & unknown;
};
/**
* hexBinary